List Record Lists

get

https://api.talkdeskapp.com/record-lists

Returns a paginated list of record lists for the account.
Use this endpoint to retrieve all record lists with optional filtering by name, status, team, and campaign.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

record-lists:manage

Query Params

name

string

length between 1 and 35

Filter by record lists names,fuzzy query

status

string

length ≥ 1

Filter Record Lists by status

team_id

string

Filter Record Lists by team id. team_id and team_ids are mutually exclusive.

team_ids

array of strings

Filter Record Lists by team ids. team_id and team_ids are mutually exclusive.

team_ids

campaign_ids

array of strings

Filter Record Lists by campaign ids.

campaign_ids

fields

string

enum

Allows to request the sub entities of the record list.

teams -> Return the record list's teams information.

Allowed:

include_none_team

string

If include_none_team equals true, this parameter will also return records lists with no team.

page

integer

1 to 2147483647

Defaults to 1

Number of the page listed

per_page

integer

1 to 500

Defaults to 50

Number of max items per page

created_at_from

string

Filter by Record Lists created_at, must filter with field created_at_to

created_at_to

string

Filter by Record Lists created_at, must filter with field created_at_from

updated_at_from

string

Filter by Record Lists updated_at, must filter with field updated_at_to

updated_at_to

string

Filter by Record Lists updated_at, must filter with field updated_at_from

order_by

string

Defaults to created_at:desc

Order by Record Lists for names, number of records, created_at, updated_at

Headers

string

enum

Defaults to application/hal+json

Generated from available response content types

Allowed:

Responses

Scope

200Get the list of record lists

400Bad Request

401Unauthorized

403Forbidden