Get all users

get

https://api.talkdeskapp.com/guardian/users

Returns a paged list of users.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

string

required

Allows filtering by using comparison and logical operators.

To search parts of a string within a field of type string then the contains operator should be used.

The syntax is the following: contains(field, 'value')

Logical operators are and and or.

When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.

(note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

Examples:

(contains(user_id, 'agent1') or contains(user_id, 'agent2')) and active eq true

contains(user_id, 'agent1')

More information here

order_by

string

Defaults to id:asc

Sorts by the indicated field in the specified direction, ascending or descending.
The expression format may contain the suffix asc or desc separated from the property name with a colon in between.

Examples:

login_timestamp:desc

More information here

page

int32

1 to 2147483647

Defaults to 1

per_page

int32

1 to 250

Defaults to 20

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Paginated list of users

400Bad Request

401Unauthorized

403Forbidden

404Not Found

406Not Acceptable