Skip to main content
GET /v1/deployments Retrieves all deployments under the current account with cursor pagination. Results are sorted by creation time in descending order (newest first). Archived deployments are excluded by default.

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer $QODER_PAT

​
Query parameters

ParameterTypeRequiredDescription
limitintegerNoMaximum number of records to return. Default 20, max 1000.
after_idstringNoCursor pagination: return records after this ID
before_idstringNoCursor pagination: return records before this ID
statusstringNoFilter by status: active, paused
include_archivedbooleanNoInclude archived deployments. Default false.
agent_idstringNoFilter by Agent ID

​
Example request

curl -X GET "https://api.qoder.com/api/v1/cloud/deployments?limit=2" \
  -H "Authorization: Bearer $QODER_PAT"

​
Example response

HTTP 200 OK 
{
  "data": [
    {
      "agent": {
        "id": "agent_019eb4d4a06d747c865d5800b9c57ae2",
        "type": "agent",
        "version": 1
      },
      "archived_at": null,
      "created_at": "2026-06-14T08:53:32Z",
      "description": "Deployment created for API documentation verification",
      "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
      "id": "dep_019ec556114c78f8b60ee34fcb98bf59",
      "initial_events": [
        {
          "content": "Generate today's status report",
          "type": "user.message"
        }
      ],
      "metadata": {
        "cas_config": {
          "config": {
            "max_concurrent": 1,
            "max_retries": 0,
            "timeout_ms": 300000
          },
          "session_strategy": "new_session",
          "stats": {
            "consecutive_failures": 0,
            "next_trigger_at": "2026-06-15T01:00:00Z",
            "total_failures": 0,
            "total_runs": 0
          }
        }
      },
      "name": "api-doc-verification-deployment",
      "paused_reason": null,
      "resources": [],
      "schedule": {
        "expression": "0 9 * * *",
        "timezone": "Asia/Shanghai",
        "type": "cron",
        "upcoming_runs_at": [
          "2026-06-15T01:00:00Z",
          "2026-06-16T01:00:00Z",
          "2026-06-17T01:00:00Z",
          "2026-06-18T01:00:00Z",
          "2026-06-19T01:00:00Z"
        ]
      },
      "status": "active",
      "type": "deployment",
      "updated_at": "2026-06-14T08:53:32Z",
      "vault_ids": []
    }
  ],
  "first_id": "dep_019ec556114c78f8b60ee34fcb98bf59",
  "has_more": true,
  "last_id": "dep_019ec51604b87aaea12568c9ab7b7025",
  "next_page": "dep_019ec51604b87aaea12568c9ab7b7025"
}

​
Response fields

FieldTypeDescription
dataarrayList of Deployment objects
first_idstringID of the first record on the current page
last_idstringID of the last record on the current page
has_morebooleanWhether more records are available
next_pagestring or nullCursor value for the next page (same as last_id when has_more is true, null otherwise)
Use last_id as the after_id parameter on the next request to page forward.

​
Errors

HTTPTypeTrigger
401authentication_errorPAT invalid or expired
See Errors for the full error envelope.

Create a deployment

Create a new cron-scheduled or manually-triggered deployment.

Get a deployment

Retrieve details for a single deployment.

List all runs

Query run history across all deployments.

Errors reference

All API error codes and the error envelope convention.