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": "project-id-123",
    "active": true
  }
]

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

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
​
key
string
required

The API key.

Example:

"api-key-123"

​
label
string
required

A short name for the API key.

Example:

"MailMonkey API Key"

​
scopes
string[]
required

The scopes for the API key.

​
projectId
string
required

The project ID.

Example:

"project-id-123"

​
active
boolean

Whether the API key is active.

Example:

true

Was this page helpful?

Suggest editsRaise issue
Get providerCreate a new API key