For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

Retrieve a project API key

Provides the API key for a project. A project ID is required when the
organization has more than one project.

get/v1/projects/api-key

Authorizations

Authorizationstringrequired

http

Query parameters

project_idstring

The project ID. Required when the organization has more than one project.

Example:12345
Constraints:pattern: ^[1-9][0-9]*$

Response

application/json
200· The project API key alongside the project name and ID.
dataobjectrequired

A project API key and the project it belongs to.

Show child attributes
objectstringrequired

Resource type.

project_idstringrequired

Amplitude project identifier.

Example:12345
Constraints:pattern: ^[1-9][0-9]*$
project_namestringrequired

Project name, or null when no name is available.

Example:Example Project
Constraints:nullable
api_keystringrequired

The project API key.

Example:example-project-api-key
Constraints:min length: 1
400· The query is invalid, or a project ID is required because the organization has more than one project.
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable
403· Permission to retrieve the project API key is denied, or the endpoint is unavailable.
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable
404· The project does not exist in the authenticated organization or is not accessible to the caller (project_not_found).
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable
422· API key retrieval is not supported for this project. For example, portfolio views and warehouse-native projects do not support this operation.
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable
502· The project API key could not be retrieved (upstream_error). Retry later.
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable
503· The project API key is missing or unusable. Ask an administrator of your organization to review the project's API key settings.If the endpoint is temporarily unavailable, retry later.
typestringrequired
Constraints:format: uri
titlestringrequired
statusintegerrequired
Constraints:min: 400max: 599
detailstring
Constraints:nullable
instancestring
Constraints:format: urinullable
error_codestringrequired
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullablemin: 0
validation_errorsobject[]
Constraints:nullable

Was this helpful?