List Employees

get/accounts/{accountId}/employees

Returns an (optionally) filtered list of all employees in an account accessible to the authenticated user.

Scope: read:employees

Request

Path Parameters

Name	Type	Required	Example	Description
accountId	string	required	4eb62cb48c9f429c93bc26664c1a5a4d	Unique identifier of an account.

Query String Parameters

Name	Type	Required	Example	Description
filter	string	optional	name:Scottie*	A search string that contains `field:values` together with boolean operators, which can be used to filter the result. An asterix (``) can also be used as a wildcard for partial matches on words. Logical operators (`AND` and `OR`) can be used between terms. Terms can be grouped via parenthesis to build complex search queries (see examples below). The fields used in the field must be fields returned from the REST API endpoint. Some example filters: `firstName:John` which would return employees whose firstName was John. `surname:Smith OR surname:Klein` which would return employees whose surname was either Smith or Klein. `surname:Smi` which would return employees whose surname is Smith, Smits, Smithe, etc. `type:LegalEntity AND postcode:2000` which would return all branches that are Legal Entities and in postcode 2000. `postcode:2000 OR postcode:3000` which would return all branches in either postcode of 2000 or in postcode 3000. `type:LegalEntity AND (postcode:2000 OR postcode:3000)` which would return all branches that are Legal Entities and in postcode 2000 or 3000. Date filter: Date range inclusive: `dateUpdatedUTC:[2021-01-01 TO 2021-12-31]` Date range exclusive: `dateUpdateUTC:{2021-01-01 TO 2021-12-31}` Unbounded range: `dateUpdatedUTC:{* TO 2021-01-01}`
sort	array	optional	sort=name:asc&sort=type:desc	WIP Description Specify the field, followed by asc/desc, separated by :
first	integer	optional	100	WIP Description Pagination: Indicates the number of items that would be in the results. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
after	string	optional	342dfs09ds329320	WIP Description Pagination: Start Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
last	integer	optional	100	WIP Description Pagination: Indicates the number of items that would be in the results NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.
before	string	optional	531dfs09ds332932	WIP Description Pagination: End Cursor for the requested Page. NB: Pagination would be invalidated if the filter/sort parms change on a subsequent call.

Responses

The request was successful, the response contains an array of employees (in summary form) in the account, wrapped in pagination information.