List deployments

GET

/api/v1/deployments

const url = 'http://localhost:3000/api/v1/deployments?status=PENDING&strategy=IMMEDIATE&createdFrom=2026-01-01&createdTo=2026-01-31&limit=20&offset=0';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/api/v1/deployments?status=PENDING&strategy=IMMEDIATE&createdFrom=2026-01-01&createdTo=2026-01-31&limit=20&offset=0' \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a paginated list of deployments with optional filtering by status, name, search, device, application version, application, rollout strategy and creation date range.

Authorizations

api-key
bearer

Parameters

Query Parameters

status

string

Allowed values: PENDING INSTALLING INSTALLED FAILED REMOVING REMOVED

Filter by deployment status

search

string

Search in deployment name and status message

name

string

Filter by deployment name (contains, case-insensitive)

deviceId

string format: uuid

Only deployments that have an instance targeting this device

applicationDescriptionId

string format: uuid

Only deployments of this application description (version)

applicationPackageId

string format: uuid

Only deployments whose application description belongs to this application

strategy

string

Allowed values: IMMEDIATE CANARY ROLLING

Filter by rollout strategy

createdFrom

string

Example

2026-01-01

Inclusive lower bound on createdAt. ISO 8601 YYYY-MM-DD (00:00 UTC) or a date-time with a zone.

createdTo

string

Example

2026-01-31

Inclusive upper bound on createdAt. A date-only value (YYYY-MM-DD) includes the whole UTC day. createdFrom later than createdTo is rejected with 400.

limit

number

default: 20 >= 1 <= 100

Page size

offset

number

Number of results to skip

cursor

string

Cursor for pagination

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

List of deployments retrieved successfully

400

Bad request - a query parameter is malformed, or createdFrom is after createdTo

401

Unauthorized - Invalid or missing authentication

403

Forbidden — caller lacks required permission

503

Service unavailable - Deployment service is not reachable