GET
/
projects
/
{projectIdOrName}
/
api-keys
/
{apiKey}
Get an API key
curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/api-keys/{apiKey} \
  --header 'X-Api-Key: <api-key>'
{
  "key": "api-key-123",
  "label": "MailMonkey API Key",
  "scopes": [
    [
      "full",
      "frontend"
    ]
  ],
  "projectId": "my-project",
  "active": true
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

projectIdOrName
string
required

The Ampersand project ID or project name.

apiKey
string
required

API key to access Ampersand APIs.

Response

API key

The response is of type object.