Get the paginated list of articles

get

https://api.talkdeskapp.com/locations-directory/articles

Get the paginated list of articles. An article is a versioned piece of content — for example a note or an FAQ entry — of a given article type, linked to one or more LOCATION, SERVICE, or STAFF entities (see the Article Types API for how a type's link patterns and content shape are configured). Only the current, live version of each article is listed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

locations-directory:read

Query Params

type

string

length between 1 and 64

Filter by the id of the article's type.

location

array of strings

Filter by linked LOCATION entity ids — matches articles linked to any of the given ids. Repeat the parameter for multiple values, e.g. location=a&location=b.

location

service

array of strings

Filter by linked SERVICE entity ids — matches articles linked to any of the given ids. Repeat the parameter for multiple values, e.g. service=a&service=b.

service

staff

array of strings

Filter by linked STAFF entity ids — matches articles linked to any of the given ids. Repeat the parameter for multiple values, e.g. staff=a&staff=b.

staff

Scope

200The paginated list of articles.

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error