Get a List of Records

get

https://api.talkdeskapp.com/record-lists/{id}/records

Returns a paginated list of records from a record list.
Use this endpoint to retrieve all contact records with optional filtering, searching, and sorting.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

record-lists:manage

Path Params

string

required

length between 1 and 36

The identifier of the record list.

Query Params

phone_number

string

length between 1 and 20

Filter Records by phone number

page

integer

1 to 2147483647

number of the page listed

per_page

integer

1 to 500

Defaults to 50

Number of max items per page

upload_request_id

string

length between 1 and 36

Filter Records by upload request id

string

length between 3 and 80

Fuzzy search records by first name, last name or phone number

search_fields

string

length between 1 and 35

Defaults to first_name,last_name,phone_number

Supported search fields, include first_name, last_name, phone_number, which joint by ','

order_by

string

enum

length between 1 and 35

Defaults to updated_at:desc

Sort the records by updated time and priority

Allowed:

priorities

string

length between 1 and 500

Filter records by priorities, multiple priority which joint by ','

timezones

string

length between 1 and 500

Filter records by timezones, multiple timezone which joint by ','

updated_at_from

date-time

length ≤ 35

Interval starting point of updated time, must filter with field created_at_to

updated_at_to

date-time

length ≤ 35

Interval ending point of updated time, must filter with field updated_at_from

extra_data_filter

array of strings

length between 1 and 20

Filter records by extra_data fields. Multiple filters can be provided to narrow results.
Format: 'key:value' for exact match, or 'key:' to check if key exists.
Same key with different values are OR'd together, different keys are AND'd.
Maximum 20 filters allowed.

extra_data_filter

Headers

string

enum

Defaults to application/hal+json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/hal+json

application/json

Scope

200Get a list of records

400Bad Request

401Unauthorized

403Forbidden

404Record List not found.