get https://api.talkdeskapp.com/prompts//flows
Get the flow list by a prompt ID.
Scope
prompts:read
Body Response - Schema
200 (prompt usage)
| Parameter | Type | Description | Required |
|---|---|---|---|
| total | integer | N/A | yes |
| page | integer | Default: 1 | yes |
| per_page | integer | Default: 20 | yes |
| _embedded | object | "_embedded" subdivides into: 1 - "prompt_flows" (array[object]). Required. 1.1 - "id" (string) - the ID of the prompt. Required. 1.2 - "flow_id" (string) - ID of the flow. Required. 1.3 - "published_flow_version" (object) - published flow version of the flow. Required. 1.3.1 - "flow_id" (string). Required. 1.3.2 - "flow_name" (string). Required. 1.3.3 - "flow_version_id" (string). Required. 1.3.4 - "flow_version_status" (string) - <= 255 characters. Allowed values: PUBLISHED, DRAFT. Required. 1.3.5 - "flow_trigger_type" (string) - Allowed values: VOICE_INBOUND, API, MESSAGE_INBOUND, MODULE 1.4 - "draft_flow_version" (object) - draft flow version of the flow. 1.4.1 - "flow_id" (string). Required. 1.4.2 - "flow_name" (string). Required. 1.4.3 - "flow_version_id" (string). Required. 1.4.4 - "flow_version_status" (string) - <= 255 characters. Allowed values: PUBLISHED, DRAFT. Required. 1.3.5 - "flow_trigger_type" (string) - Allowed values: VOICE_INBOUND, API, MESSAGE_INBOUND, MODULE | yes |
| _links | object | HAL API-related links. "_links" subdivides into: 1 - "self" (object) - current page of this prompts list 1.1 - "href" (string) - address of the resource. Default: https://prompts.talkdesk.com/prompts/1/flows?page=2 1.2 - "prev" (object) - previous page of this prompts list. 1.2.1 - "href" (string) - address of the resource. Default: https://prompts.talkdesk.com/prompts/1/flows?page=1 1.3 - "next" (object) - next page of this prompts list. 1.3.1 - "href" (string) - address of the resource. Default: https://prompts.talkdesk.com/prompts/1/flows?page=3 | yes |
400 (Invalid parameter), 401 (unauthorized access - invalid or unverifiable JWT), 403 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.