SendGrid

Twilio SendGrid Teammates API

The Twilio SendGrid Teammates API allows you to add, manage, and remove Teammates, or user accounts, from your SendGrid account. Teammates function like user…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Twilio SendGrid Teammates API allows you to add, manage, and remove Teammates, or user accounts, from your SendGrid account. Teammates function like user accounts on the SendGrid account, allowing you to invite additional users to your account with scoped access. You can think of Teammates as SendGrid's approach to enabling role-based access control for your SendGrid account. For even more control over the access to your account, see the Twilio SendGrid SSO API, which enables SSO-authenticated Teammates to be managed through a SAML 2.0 identity provider.

Endpoints 9

Teammates

  • GETRetrieve all teammates/v3/teammates?limit=500&offset=0This endpoint allows you to retrieve a paginated list of all current Teammates. You can use the limit query parameter to set the page size. If your list…
  • POSTInvite teammate/v3/teammatesThis endpoint allows you to invite a Teammate to your account via email. You can set a Teammate's initial permissions using the scopes array in the request…
  • GETGet Teammate Subuser Access/v3/teammates/:teammate_name/subuser_access?after_subuser_id=0&limit=100&username=stringThis operation allows you to retrieve the Subusers that can be accessed by a specified Teammate. This operation will return the Subusers available to a…
  • GETRetrieve specific teammate/v3/teammates/:usernameThis 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…
  • DELETEDelete teammate/v3/teammates/:usernameThis endpoint allows you to delete a teammate. Only the parent user or an admin teammate can delete another teammate.
  • PATCHUpdate teammate's permissions/v3/teammates/:usernameThis endpoint allows you to update a teammate’s permissions. To turn a teammate into an admin, the request body should contain an is_admin set to true.…
  • GETRetrieve all pending teammates/v3/teammates/pendingThis 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…
  • DELETEDelete pending teammate/v3/teammates/pending/:tokenThis endpoint allows you to delete a pending teammate invite.
  • POSTResend teammate invite/v3/teammates/pending/:token/resendThis endpoint allows you to resend a Teammate invitation. Teammate invitations will expire after 7 days. Resending an invitation will reset the expiration date.

API details

Base URL
https://api.sendgrid.com
https://api.eu.sendgrid.com
Authentication
A bearer token in the Authorization header
Operations
9 operations on 6 pathsGET 4POST 2DELETE 2PATCH 1
Main resources
Teammates 9
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the Twilio SendGrid Teammates API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Teammates API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve all teammates” (GET /v3/teammates?limit=500&offset=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio SendGrid Teammates API?

The Twilio SendGrid Teammates API allows you to add, manage, and remove Teammates, or user accounts, from your SendGrid account. Teammates function like user… It is listed under Communication and has 9 endpoints.

Who publishes the Twilio SendGrid Teammates API?

It is listed from SendGrid's public API description (an OpenAPI document), not published by SendGrid on Swastik Codes. Anyone who controls sendgrid.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Twilio SendGrid Teammates API?

Its description lists 2 base URLs: https://api.sendgrid.com, https://api.eu.sendgrid.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Twilio SendGrid Teammates API?

With A bearer token in the Authorization header.

How many endpoints does the Twilio SendGrid Teammates API have?

9 operations on 6 paths (4 GET, 2 POST, 2 DELETE, 1 PATCH). The largest groups are Teammates.

Is forking the Twilio SendGrid Teammates API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.