Search Users

get

https://api.soldo.com/business/v2/employees

Endpoint to find Users using filtering parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customreferenceId

string

The reference of the User in an external system.

name

string

The name of the User.

surname

string

The surname of the User.

visible

boolean

The visibility property of the User.

jobTitle

string

The job title of the User.

department

string

The department of the User.

string

The email address of the User.

mobile

string

The mobile number of the User.

status

string

enum

The status of the User.

Allowed:

string

The ID of the User.

groupId

string

The ID of the Group the User is a member of.

reportsTo

array of strings

The IDs of the User to which they could report to.

reportsTo

workStatus

array of objects

Filters users by their work status.

int32

Defaults to 0

It indicates the specific page to display (the counter starts from zero).

int32

≤ 50

Defaults to 0

It indicates the number of items per page.

string

enum

It indicates how the pages are ordered.

Allowed:

props

array of strings

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

props

Responses

400

Your request has missing arguments or is malformed.

200The result array contains Users.