Projects
List projects
Returns all projects under the authenticated organization, ordered by creation date (newest first).
curl --request GET \
--url 'https://api.nookdocs.com/v1/projects' \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"github_repo": "<string>",
"custom_domain": "<string>",
"github_branch": "main",
"last_deploy_at": "2023-11-07T05:31:56Z"
}
],
"total": 123
}Scoped to your organization
Results only include projects under the organization that owns the API key — there is no cross-org listing. Ordered by creation date, newest first.
Find broken deploys fast
Combine the status filter with a small limit to surface projects
whose last sync failed:
curl 'https://api.nookdocs.com/v1/projects?status=failed&limit=5' \
-H 'Authorization: Bearer nook_...'Valid statuses: pending, building, active, failed.
Authorizations
AuthorizationstringheaderrequiredAPI key issued from your dashboard (Settings → API Keys). Format: nook_... — pass as Authorization: Bearer nook_.... Keys carry scopes (projects:read/write, pages:read, deployments:read/trigger, analytics:read) — calls without the required scope return 403.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query parameters
limitintegerquerydefault: 20statusenum<string>querypendingbuildingactivefailedResponse
Array of projects
dataobject[]totalintegererrorstringrequiredmessagestringrequired