get https://api.talkdeskapp.com/record-lists/
Scope
record-lists:manage
Body Response - Schema
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | ID of the record list created | no |
| name | string | record list name | no |
| unique_identifier_type | string | Duplicate checking logic configured for the record list: PHONE_NUMBER - duplicate checking based on the record's phone_number. EXTERNAL - duplicate checking based on the record's external_id and external_provider. NOTHING - no duplicate checking. | no |
| created_at | string | record list creation date | no |
| updated_at | string | record list updated date | no |
| status | string | Status of validation process done on the record list csv file. Allowed values: REJECTED VALIDATION_STARTED UPLOADED ACCEPTED INCOMPLETE CORRUPTED | no |
| records_count | integer | how many records are present in the record list | no |
| teams | array[object] | Teams that this record belongs to. "teams" subdivides into: 1 - "id" (object) - the team ID of the record list. 2 - "name" (string) - the team name of the record list. 3 - "_links" (object) - the team name of the record list. 3.1 - "self" (object) 3.1.1 - "href" (string) | no |
401 (unauthorized), 403 (forbidden), 404 (record list 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.