Menu

Expand
Rate this page:

Teammates

Give and adjust account access.

Retrieve specific teammate

GET /v3/teammates/{username}

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

This endpoint allows you to retrieve a specific Teammate by username.

You can retrieve the username's for each of your Teammates using the "Retrieve all Teammates" endpoint.

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.

Path Parameters

username
string

The username of the teammate that you want to retrieve.

default: None
required

Responses

object
username
string

Teammate's username

first_name
string

Teammate's first name

last_name
string

Teammate's last name

email
string

Teammate's email

scopes
array[]

Scopes associated to teammate

user_type
string

Indicate the type of user: account owner, 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

        
        
        

        Retrieve specific teammate

        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!

              thanks-feedback-gif