GET
/
deployments
/
{deployment_id}
curl --request GET \
  --url https://web.inquira.app/api/v1/deployments/{deployment_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_at": "2023-11-07T05:31:56Z",
  "end_by": "2023-11-07T05:31:56Z",
  "stopped_at": "2023-11-07T05:31:56Z",
  "call_type": "inbound",
  "workflow_release_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "call_config": {
    "max_attempts": 3,
    "call_window": {
      "start_time": "09:00",
      "end_time": "17:00"
    }
  },
  "timezone": "America/New_York",
  "workflow_releases": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Path Parameters

​
deployment_id
string
required

ID of the deployment

Response

200
application/json
Detailed deployment information
​
id
string
required

Unique identifier for the deployment

​
start_at
string
required

ISO timestamp when the deployment starts

​
end_by
string | null
required

ISO timestamp when the deployment should end

​
stopped_at
string | null
required

ISO timestamp when the deployment was stopped, null if still active

​
call_type
enum<string>
required

Type of deployment - either inbound or outbound calls

Available options:
inbound,
outbound
​
workflow_release_id
string
required

ID of the workflow release associated with the deployment

​
call_config
object
required

Configuration for the call, structure varies based on call_type

Example:
{
  "max_attempts": 3,
  "call_window": {
    "start_time": "09:00",
    "end_time": "17:00"
  }
}
​
timezone
string
required

Timezone for the deployment

Example:

"America/New_York"

​
workflow_releases
object
required

Details of the associated workflow release

List DeploymentsList Deployment Calls