Menu

Expand
Rate this page:

Sender Identities API

Get all Sender Identities

GET /v3/senders

Base url: https://api.sendgrid.com

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

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

default: None

Responses

object
result
array[object]
id
integer

The unique identifier of the Sender.

required
nickname
string

A nickname for the Sender. Not used for sending.

required
from
object
required
email
string

The email address from which your recipient will receive emails.

required
name
string

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

required
reply_to
object
required
email
string

The email address to which your recipient will reply.

required
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.

required
address_2
string

Additional Sender address information.

city
string

The city of the Sender.

required
state
string

The state of the Sender.

zip
string

The zipcode of the Sender.

country
string

The country of the Sender.

required
verified
boolean

A boolean flag indicating whether the Sender is verified or not. Only verified Senders can be used to send email.

required
locked
boolean

A boolean flag that is true when the Sender is associated with a campaign in Draft, Scheduled, or In Progress status. You cannot update or delete a locked Sender.

required
updated_at
integer

The time the Sender was last updated.

required
created_at
integer

The time the Sender was created.

required
Loading Code Sample...
        
        

        Get all Sender Identities

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

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

              Thanks for your feedback!

              thanks-feedback-gif