Retrieve all teammates

Teammates

Give and adjust account access.

Retrieve all teammates

GET /teammates

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

The number of results to return.

offset

integer

The point in the list to begin retrieving results.

Responses

object

result

array[object]

username

string

Teammate's username

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

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.