DeploymentsList deployments

List deployments

Returns recent deployments for this documentation project, newest first.

curl -X GET "https://api.documentationai.app/api/v1/deployments?limit=20&offset=0" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "deployments": [
    {
      "deploymentId": "9f1c2e64-3b47-4a8d-91f5-7c2e0a6d5b31",
      "status": "ready",
      "url": "https://docs.acme.com",
      "branch": "main",
      "isPreview": false,
      "triggerType": "api",
      "logs": "example_string",
      "createdAt": "2026-07-28T10:00:00.000Z",
      "updatedAt": "2026-07-28T10:01:32.000Z"
    }
  ],
  "total": 42
}
GET
/deployments
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...
query
limitinteger

Maximum number of deployments to return

Min: 1 • Max: 100
query
offsetinteger

Number of deployments to skip

Min: 0
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. API key generated from the Documentation.AI dashboard (Settings → API Keys). Pass as Authorization: Bearer dai_...

Query Parameters

limitinteger

Maximum number of deployments to return

offsetinteger

Number of deployments to skip

Responses

deploymentsarray
totalinteger

Deployments recorded for this project