Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
On this page

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

Operation overview

operation-overview page anchor

GET/v3/scopes

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

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.

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.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
on-behalf-ofstringOptional

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.

Responses

responses page anchor
200401403404500
SchemaExample
Property nameTypeRequiredDescriptionChild properties
scopesarray[string]

The list of scopes for which this user has access.

Retrieve a list of scopes for which this user has access.Link to code sample: Retrieve a list of scopes for which this user has access.
1
const client = require('@sendgrid/client');

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4


5
const request = {

6
  url: `/v3/scopes`,

7
  method: 'GET',

8
  

9
}

10


11
client.request(request)

12
  .then(([response, body]) => {

13
    console.log(response.statusCode);

14
    console.log(response.body);

15
  })

16
  .catch(error => {

17
    console.error(error);

18
  });