Retrieve a list of scopes for which this user has access.
GET /v3/scopes
Base url: https://api.sendgrid.com
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.
Authentication
- API Key
Headers
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
The list of scopes for which this user has access.
uniqueItems: TrueThis 401 response indicates that the user making the call doesn't have the authorization to view the list of scopes.
This empty field is returned instead of the list of scopes if the user making the call doesn't have the authorization required.
Explains why the scopes cannot be returned.
the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}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.
