Menu

Sender Identities API

Get all Sender Identities

GET /senders

This endpoint allows you to retrieve a list of all sender identities that have been created for your account.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Responses

object
result
array[object]
nickname
string

A nickname for the sender identity. Not used for sending.

from
object
email
string

The email address from which your recipient will receive emails.

name
string

The name appended to the from email field. Typically your name or company name.

reply_to
object
email
string

The email address to which your recipient will reply.

name
string

The name appended to the reply to email field. Typically your name or company name.

address
string

The physical address of the sender identity.

address_2
string

Additional sender identity address information.

city
string

The city of the sender identity.

state
string

The state of the sender identity.

zip
string

The zipcode of the sender identity.

country
string

The country of the sender identity.

id
integer

The unique identifier of the sender identity.

verified
boolean

If the sender identity is verified or not. Only verified sender identities can be used to send email.

updated_at
integer

The time the sender identity was last updated.

created_at
integer

The time the sender identity was created.

locked
boolean

True when the sender id is associated to a campaign in the Draft, Scheduled, or In Progress status. You cannot update or delete a locked sender identity.

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more