Menu

Expand
Rate this page:

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 paramater. To return results from a specific Teammate, use the offset paramter. The Response Headers will include pagination info.

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.

Query String

limit
integer

Number of items to return

default: 500
offset
integer

Paging offset

default: 0

Responses

object
result
array[object]
username
string

Teammate's username

email
string

Teammate's email

first_name
string

Teammate's first name

last_name
string

Teammate's last name

user_type
string

Indicate the type of user: owner user, teammate admin user, or normal teammate

Allowed Values: admin, owner, teammate
is_admin
boolean

Set to true if teammate has admin privileges

phone
string

(optional) Teammate's phone number

website
string

(optional) Teammate's website

address
string

(optional) Teammate's address

address2
string

(optional) Teammate's address

city
string

(optional) Teammate's city

state
string

(optional) Teammate's state

zip
string

(optional) Teammate's zip

country
string

(optional) Teammate's country

        
        
        
        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.

              
              
              

              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!

              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