Skip to Content
SendlySendly
API ReferenceApi keys

Get an API key

GET
/api/projects/{id}/api-keys/{keyId}

Returns one key on the project, revoked or not. Never returns a token or its hash: lastFour is the only fragment of the secret that survives creation. 404 if the key does not exist under this project.

Requires the api-keys:read scope — See which API keys exist, including what each one is allowed to do.

cookiebetter-auth.session_token<token>

BetterAuth session cookie. Used by the dashboard / browser clients. When present, the active project is taken from the x-project-id header.

id*string

Project id.

keyId*string

API key id.

Response Body

The API key

application/json
  1. response
success*true
Value intrue
data*

An API key's metadata. Never carries the token or its hash — lastFour is the only surviving fragment of the secret once the key has been created.

Example Request
curl -X GET 'https://api.sendly.now/api/projects/string/api-keys/string'
Example Response
{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",    "name": "string",    "lastFour": "string",    "legacyGrantPreset": "FULL",    "mode": "LIVE",    "scopes": [      "emails:send"    ],    "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",    "lastUsedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "revokedAt": "2019-08-24T14:15:22Z"  }}