Developer APIResourcesProjects

List deployments

Retrieves a list of deployments. Query parameters may be used to filter results to a specific project, state, environment type, date range, and more.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

project_idstringOptional
A project ID. If provided, only deployments associated with the specified project are included in the response.
statestringOptional

The state of the deployments to retrieve. If provided, only deployments with the provided state are included in the response. Must be one of: pending, success, or failed.

environment_typestringOptional

An environment type. Only deployments associated with the specified environment are included in the response if provided. Accepted values include the following:

  • sandbox

  • test

  • stage

  • uat

  • preprod

  • prod

fromstringOptional
Deployments created after this time are included in the response. The value must be an ISO 8601 timestamp.
tostringOptional
Deployments created before this time are included in the response. The value must be an ISO 8601 timestamp.

Response

Array of deployment items with review and approval details when enabled
itemslist of objects or null
Array of deployment details.

Errors