GET
/
projects
/
{projectIdOrName}
/
api-keys
curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/api-keys \
  --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.

Query Parameters

active
boolean

Whether to include only active API keys. If false, all API keys are included.

Response

200
application/json
List of API keys

The response is of type object[].