provider API Keys GET /api_keys/{api_key_id}
@utdk/sendgrid /api_keys/{api_key_id}
Retrieve an existing API Key
**This endpoint allows you to retrieve a single API key using an `api_key_id`.** The endpoint will return a key's name, ID, and scopes. If the API Key ID does not, exist a `404` status will be returned. See the [API Key Permissions List](https://sendgrid.api-docs.io/v3.0/how-to-use-the-sendgrid-v3-api/api-authorization) for all available scopes. An API key's scopes can be updated after creation using the "Update API keys" endpoint.
api_key_id path required
string
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
getApiKeysApiKeyId
GET/api_keys/{api_key_id}
**This endpoint allows you to retrieve a single API key using an `api_key_id`.** The endpoint will return a key's name, ID, and scopes. If the API Key ID does not, exist a `404` status will be returned. See the [API Key Permissions List](https://sendgrid.api-docs.io/v3.0/how-to-use-the-sendgrid-v3-api/api-authorization) for all available scopes. An API key's scopes can be updated after creation using the "Update API keys" endpoint.

Parameters

required

Configure credentials above to enable sending.

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

TypeScript

import sendgrid from '@utdk/sendgrid';

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