provider Teammates GET /teammates
@utdk/sendgrid /teammates
Retrieve all 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.
limit query
Number of items to return
integer
offset query
Paging offset
integer
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getV3Teammates
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.

Number of items to return

Paging offset

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.getV3Teammates({
  "limit": 500,
  "offset": 0,
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})