Menu

Teammates

Give and adjust account access.

Retrieve all pending teammates

Retrieve all pending teammates

GET /teammates/pending

This endpoint allows you to retrieve a list of all pending Teammate invitations.

Each teammate invitation is valid for 7 days. Users may resend the invitation to refresh the expiration date.

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.

Responses

object
result
array[object]
email
string

Email address teammate invite will be sent to

scopes
array[string]

List of permissions to give teammate if they accept

is_admin
boolean

Set to true to indicate teammate should have the same set of permissions as parent user

token
string

Invitation token used to identify user

expiration_date
integer

timestamp indicates when invite will expire. Expiration is 7 days after invite creation

Rate this page:

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.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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