Menu

Expand
Rate this page:

Teammates

Give and adjust account access.

Retrieve all pending teammates

GET /v3/teammates/pending

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

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

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.

default: None

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

Loading Code Sample...
        
        

        Retrieve all pending teammates

        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.

        Loading Code Sample...
              
              
              

              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