Skip to main content
GET
This endpoint requires an organization admin API key (ASA_ prefix). Standard project API keys cannot access this endpoint.

Authorizations

string | header
required
Organization admin API key header of the form Bearer ASA_<key>. Standard project API keys (AS_ prefix) will receive a 403 error.

Path Parameters

string
required
The project’s unique ID. Must be a valid Mongo ObjectId.

Response

Project retrieved successfully
boolean
Indicates if the request was successfulExample: true
object
The project object
The response intentionally contains no secrets. It never includes API keys or credentials, SES tokens, or DKIM keys.

Error Responses

object
Returned when the supplied projectId is not a valid Mongo ObjectId.
object
Returned when using a standard project API key instead of an organization admin API key.
object
Returned when no project with that ID exists in the organization. This is also returned when the project belongs to a different organization.