List omnichannel steps
GET/:organization_id/omnichannel_steps
Returns a paginated list of omnichannel steps for an organization
Request
Path Parameters
organization_id integerrequired
Organization ID
Query Parameters
dialer_campaign_id integer
Filter steps by dialer campaign ID
page integer
Page number for pagination
Default value:
1
per_page integer
Number of items per page
Default value:
20
sort_by string
Possible values: [order
, channel
, created_at
, updated_at
]
Field to sort by
Default value:
order
sort_order string
Possible values: [asc
, desc
]
Sort order (ascending or descending)
Default value:
asc
Responses
- 200
- 401
- 403
Successful response
- application/json
- Schema
- Example (auto)
Schema
data object[]
meta object
{
"data": [
{
"id": 0,
"organization_id": 0,
"dialer_campaign_id": 0,
"order": 0,
"channel": "SMS",
"retry_interval_seconds": 0,
"delay_seconds": 0,
"max_attempts": 0,
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}
],
"meta": {
"pagination": {
"current_page": 0,
"total_pages": 0,
"total_count": 0,
"per_page": 0
}
}
}
Unauthorized
Forbidden
Authorization: http
name: basicAuthtype: httpscheme: basicdescription: Basic authentication using API key ID and API key
- python
- nodejs
- ruby
- curl
- go
- php
- java
- powershell
- javascript
- rust
- HTTP.CLIENT
- REQUESTS
import http.client
conn = http.client.HTTPSConnection("cloud-staging.cloverhound.com")
payload = ''
headers = {
'Accept': 'application/json',
'Authorization': 'Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
}
conn.request("GET", "/:organization_id/omnichannel_steps", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))