List Non-Employee Records
GET {{baseUrl}}/non-employee-records
This gets a list of non-employee records. There are two contextual uses for this endpoint:
1. The user has the role context of idn:nesr:read
, in which case they can get a list of all of the non-employees.
2. The user is an account manager, in which case they can get a list of the non-employees that they manage.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | number | Max number of results to return. | |
See V3 API Standard Collection Parameters for more information. | |||
offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. | |
See V3 API Standard Collection Parameters for more information. | |||
count | boolean | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. |
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information. |
| sorters
| string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified |
| filters
| string | | Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
sourceId: eq |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"ef38f94347e94562b5bb8424a56397d8","accountName":"Abby.Smith","firstName":"William","lastName":"Smith","email":"william.smith@example.com","phone":"5555555555","manager":"jane.doe","sourceId":"2c91808568c529c60168cca6f90c1313","data":{"description":"Auditing"},"startDate":"2019-08-23T18:52:59.162Z","endDate":"2020-08-23T18:52:59.162Z","modified":"2019-08-23T18:52:59.162Z","created":"2019-08-23T18:40:35.772Z"},{"id":"ef38f94347e94562b5bb8424a56397d8","accountName":"Abby.Smith","firstName":"William","lastName":"Smith","email":"william.smith@example.com","phone":"5555555555","manager":"jane.doe","sourceId":"2c91808568c529c60168cca6f90c1313","data":{"description":"Auditing"},"startDate":"2019-08-23T18:52:59.162Z","endDate":"2020-08-23T18:52:59.162Z","modified":"2019-08-23T18:52:59.162Z","created":"2019-08-23T18:40:35.772Z"}]