API ReferenceProjects

Delete a projectv3.1

DELETE
/api/v3.1/org/owner/project/{nano_id}

Deletes a project within the organization by its unique identifier. This affects every resource belonging to the project, including its API keys, webhook configurations, and connected services. The action cannot be undone. Pass ?revoke_on_delete=true to also revoke the upstream credentials of every connection in the project.

Authorization

OrgApiKeyAuth
x-org-api-key<token>

Organization API key authentication

In: header

Path Parameters

nano_idstringRequired

Unique identifier (Nano ID) of the project to delete

Format: projectId

Query Parameters

revoke_on_deletenullable boolean

When true, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a revoke_job_id. Defaults to false. Revocation is irreversible — recovering a deleted entity does not restore working credentials.

Default: false

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v3.1/org/owner/project/pr_1a2b3c4d5e6f"
{  "status": "success",  "revoke_job_id": "oj_1a2b3c4d5e6f"}
Edit this page on GitHub