Retrieve a list of scopes for which this user has access. · Email Activity (beta)

provider API Key Permissions GET /scopes

@utdk/sendgrid /scopes

Retrieve a list of scopes for which this user has access.

**This endpoint returns a list of all scopes that this user has access to.** API Keys are used to authenticate with [SendGrid's v3 API](https://sendgrid.api-docs.io/v3.0/how-to-use-the-sendgrid-v3-api/api-authorization). API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. This endpoint returns all the scopes assigned to the key you use to authenticate with it. To retrieve the scopes assigned to another key, you can pass an API key ID to the "Retrieve an existing API key" endpoint. For a more detailed explanation of how you can use API Key permissions, please visit our [API Keys documentation](https://sendgrid.com/docs/ui/account-and-settings/api-keys/).

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.

Execution Mode

Gateway URL

Saved automatically to browser storage.

Code snippet

Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

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