Returns an (optionally) filtered list of all employees in an account accessible to the authenticated user.
read:employees
Name | Type | Required | Example | Description |
---|---|---|---|---|
accountId | string | required | 4eb62cb48c9f429c93bc26664c1a5a4d | Unique identifier of an account. |
Name | Type | Required | Example | Description |
---|---|---|---|---|
filter | string | optional | name:Scottie* | A search string that contains An asterix ( The fields used in the field must be fields returned from the REST API endpoint. Some example filters:
|
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. |