Teammates
Give and adjust account access.
Retrieve all teammates
GET /v3/teammates
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve a list of all current Teammates.
You can limit the number of results returned using the limit query parameter. To return results from a specific Teammate, use the offset parameter. The Response Headers will include pagination info.
Authentication
- API Key
Headers
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.
Query String
Number of items to return
default: 500Paging offset
default: 0Responses
Teammate's username
Teammate's email
Teammate's first name
Teammate's last name
Indicate the type of user: owner user, teammate admin user, or normal teammate
Allowed Values: admin, owner, teammateSet to true if teammate has admin privileges
(optional) Teammate's phone number
(optional) Teammate's website
(optional) Teammate's address
(optional) Teammate's address
(optional) Teammate's city
(optional) Teammate's state
(optional) Teammate's zip
(optional) Teammate's country
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.
