Zoom Public API Documentation
List flows
GET {{baseUrl}}/contact_center/flows?next_page_token=<string>&page_size=30&status=draft&channel_type=chat
Return a list of flows. Scopes: Rate Limit Label: contact_center_flow:read:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size
|
number | The number of items returned per page. | |
status
|
string | Use the status to filter the result. | |
channel_type
|
string | Use the channel type to filter the result. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"total_records": "<integer>",
"flows": [
{
"flow_id": "<string>",
"flow_name": "<string>",
"flow_description": "<string>",
"channel_type": "voice",
"status": "published",
"modified_by": "<string>",
"last_modified_time": "<string>",
"entry_points": [
{
"entry_id": "<string>",
"entry_name": "<string>",
"entry_number": "<string>",
"entry_language": "<string>"
},
{
"entry_id": "<string>",
"entry_name": "<string>",
"entry_number": "<string>",
"entry_language": "<string>"
}
],
"flow_versions": [
{
"flow_version_id": "<string>",
"flow_version_description": "<string>",
"flow_version_status": "draft",
"flow_version": "<integer>",
"flow_version_modified_by": "<string>",
"flow_version_last_modified_time": "<string>"
},
{
"flow_version_id": "<string>",
"flow_version_description": "<string>",
"flow_version_status": "published",
"flow_version": "<integer>",
"flow_version_modified_by": "<string>",
"flow_version_last_modified_time": "<string>"
}
]
},
{
"flow_id": "<string>",
"flow_name": "<string>",
"flow_description": "<string>",
"channel_type": "voice",
"status": "archived",
"modified_by": "<string>",
"last_modified_time": "<string>",
"entry_points": [
{
"entry_id": "<string>",
"entry_name": "<string>",
"entry_number": "<string>",
"entry_language": "<string>"
},
{
"entry_id": "<string>",
"entry_name": "<string>",
"entry_number": "<string>",
"entry_language": "<string>"
}
],
"flow_versions": [
{
"flow_version_id": "<string>",
"flow_version_description": "<string>",
"flow_version_status": "published",
"flow_version": "<integer>",
"flow_version_modified_by": "<string>",
"flow_version_last_modified_time": "<string>"
},
{
"flow_version_id": "<string>",
"flow_version_description": "<string>",
"flow_version_status": "published",
"flow_version": "<integer>",
"flow_version_modified_by": "<string>",
"flow_version_last_modified_time": "<string>"
}
]
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/flows?next_page_token=<string>&page_size=30&status=draft&channel_type=chat?next_page_token=<string>&page_size=30&status=draft&channel_type=chat' -H 'Accept: application/json'
ENDPOINTS