get https://api.talkdeskapp.com/prompts/
Scope
prompts:read
Body Response - Schema
200 (prompt details)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | the ID of the prompt | yes |
| name | string | the prompt name | yes |
| description | string | the prompt description | yes |
| asset_id | string | asset ID | yes |
| type | string | The prompt type. Allowed values: asset, tts, url | yes |
| created_at | string | the date when the prompt was created | no |
| created_by | string | the user who created the prompt | no |
| created_user_name | string | the username of the person who created the prompt | no |
| updated_at | string | the date when the prompt was updated | yes |
| updated_by | string | the user who updated the prompt | yes |
| updated_user_name | string | the username of the person who updated the prompt | no |
| _links | object | HAL API-related links. "_links" subdivides into: 1 - "self" (object) - link to fetch the detail of the prompt. 1.1 - "href" (string) - address of the resource. 2 - "download_link" (object) - link used to generate a download link (available only when published or archived states). 2.1 - "href" (string) - download link generation address. | yes |
401 (unauthorized access - invalid or unverifiable JWT), 403 (forbidden), 404 (prompt not found)
| 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.