get https://api.talkdeskapp.com/campaigns//users
To a campaign
Scope
campaigns:read
Body Response - Schema
200 (assigned users returned successfully)
| Parameter | Type | Description | Required |
|---|---|---|---|
| total | integer | >= 0 <= 4611686018427388000 | yes |
| count | integer | >= 0 <= 4611686018427388000 | yes |
| page | integer | >= 1 <= 4611686018427388000 | yes |
| per_page | integer | >= 1 <= 250 | yes |
| total_pages | integer | >= 1 <= 4611686018427388000 | yes |
| _embedded | object | "_embedded" subdivides into: 1 - "users" (array[object]) - the list of users. Required. 1.1 - "_links" (object) - HAL API related links. 1.1.1 - "self" (object) - link to fetch the detail of the campaign. 1.1.1.1 - "href" (string) - address of the resource. >= 78 characters <= 78 characters Required. 1.1.2 - "users" (object) - link to fetch a list of all the campaigns. 1.1.2.1 - "href" (string) - address of the resource. >= 41 characters <= 41 characters Required. 1.2 - "id" (string) - the uuid of the user. Required. | |
| _links | object | HAL API related links. "_links" subdivides into: 1 - "self" (object) - link to fetch a list of all users. 1.1 - "href" (string) - address of the resources. Required. 2 - "prev" (object) 2.1 - "href" (string) - required. 3 - "next" (object) 3.1 - "href" (string) >= 95 characters <= 2083 characters Required. 4 - "first" (object) - 4.1 - "href" (string) - required. 5 - "last" (object) - 5.1 - "href" (string) - required. | yes |
400 (errors found in the submitted data), 401 (unauthorized), 403 (forbidden), 404 (campaign 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) |
API Availability
The Campaign Management API is only available for customers enrolled in Talkdesk's Early Access (EA) program.
To enter the EA program, contact a Customer Success Manager.The Campaign Management APII has been in EA since November 2022.
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.