Search staffs by conditions

get

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

staffs-directory:read

Query Params

page

int32

1 to 2147483647

Defaults to 1

Desired page

per_page

int32

1 to 50

Defaults to 50

Limit the number of prompts per page

name

string

length between 0 and 9999

Name of staff

searchTerm

string

length between 0 and 512

Search term to filter staffs by name or email.

manager

string

length between 0 and 9999

Manager of staff

speciality

string

length between 0 and 9999

Speciality of staff

job_title

string

length between 0 and 9999

Job title of staff

external_id

string

length between 0 and 9999

External id of staff

industry

string

length between 0 and 9999

Industry of staff

gender

string

length between 0 and 9999

Gender of staff

status

string

length between 0 and 9999

Status of staff

language

string

length between 0 and 9999

Language of staff

visit_type

string

length between 0 and 9999

Visit type name of staff

location_id

string

length between 0 and 150

The id of the location. Accepts multiple ids as a comma-separated list, in which case staff
associated with any of the given ids are returned.

location_name

string

length between 0 and 150

The name of the location which staff in

location_type

string

length between 0 and 150

The type of the location which staff in

zip_code

string

length between 0 and 20

The zip-code of the location which staff in

city

string

length between 0 and 100

The city of the location which staff in

country_name

string

length between 0 and 100

The country name of location which staff in

region_name

string

length between 0 and 100

The region name (country subdivision) of location which staff in

service_id

string

length between 0 and 150

The id of the service. Accepts multiple ids as a comma-separated list, in which case staff
associated with any of the given ids are returned.

service_name

string

length between 0 and 9999

The name of the service provided by staff

service_type

string

length between 0 and 9999

The type of the service provided by staff

latitude

double

-90 to 90

Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all staffs within a certain radius.
Currently, these three parameters can only be used when the Feature Flag is enabled.

longitude

double

-180 to 180

Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all staffs within a certain radius.
Currently, these three parameters can only be used when the Feature Flag is enabled.

distance

double

≥ 0

Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all staffs within a certain radius.
Distance is measured in meters.
If no distance is provided, the default distance configured in Industries-settings will be used.
Currently, these three parameters can only be used when the Feature Flag is enabled.

order_by

string

length between 0 and 9999

Defaults to name

Order by field, should be one of -> name, external_id, manager, speciality, job_title, date_of_hire, created_at, updated_at

sort

string

length between 0 and 9999

Defaults to DESC

Sort field, should be one of -> DESC, ASC

custom_field

string

length between 1 and 255

Filters staffs by the values of their custom fields, in the format custom_field=<field_name>:<value>.
The parameter is optional and can be repeated, which is how AND and OR conditions are expressed:

Repeating the same field name matches any of its values (OR).
?custom_field=visit_category:wellness&custom_field=visit_category:acute_sick
returns the staffs whose visit_category is either wellness or acute_sick.
Using different field names requires all of them to match (AND).
?custom_field=visit_category:wellness&custom_field=has_parking:true
returns only the staffs that are in the wellness category and have parking.
The two can be combined.
?custom_field=visit_category:wellness&custom_field=visit_category:acute_sick&custom_field=has_parking:true
returns the staffs whose visit_category is wellness or acute_sick, and that also have parking.

Omitting the parameter leaves the results unfiltered.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

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

application/json

Scope

200OK

400Bad Request

401Unauthorized

403Forbidden