List Employees
get/accounts/{accountId}/employees
Returns an (optionally) filtered list of all employees in an account accessible to the authenticated user.
Scope:
read:employeesRequest
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* | Filter results using ElasticSearch Query Syntax. |
| sort | array | optional | sort=name:asc&sort=type:desc | To sort the results by either ascending or descending order |
| first | integer | optional | 100 | Pagination: Indicates the number of items per page (when After cursor is used) |
| after | string | optional | 342dfs09ds329320 | Pagination: Return objects after this cursor |
| last | integer | optional | 100 | Pagination: Indicates the number of items per page (when Before cursor is used) |
| before | string | optional | 531dfs09ds332932 | Pagination: Return objects before this cursor |
Responses
- 200
- 401
- 403
- 404
- 500
The request was successful, the response contains an array of employees (in summary form) in the account, wrapped in pagination information.
