API ReferenceProjects

Get project details by ID

Retrieves detailed information about a specific project using its unique identifier. This endpoint provides complete project configuration including webhook URLs, creation and update timestamps, and webhook secrets. Use this endpoint to inspect project settings or verify project configuration.

Path parameters

projectIdstringRequired

Unique identifier (Nano ID) of the project to retrieve

Headers

x-api-keystringRequired

Response

Project retrieved successfully. Returns a complete project object with all configuration details.
idstring
Unique identifier for the project
org_idstring
Identifier of the organization that owns this project
namestring
Name of the project
emailstringformat: "email"
Email address associated with the project
created_atstring
ISO timestamp when the project was created
updated_atstring
ISO timestamp when the project was last updated
deletedboolean

Whether this project has been soft-deleted

webhook_urlstring or nullformat: "uri"

URL where webhook events will be sent (can be null)

event_webhook_urlstring or nullformat: "uri"

URL where event webhook notifications will be sent (can be null)

webhook_secretstring or null
Secret key used to sign webhook payloads for verification
triggers_enabledboolean or null
Whether triggers are enabled for this project
last_subscribed_atdatetime or null
ISO timestamp when the project last subscribed to updates
is_new_webhookboolean or null
Indicates if the webhook configuration is using the new format

Errors