Logo
IdentityNow API Documentation

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.

 

Body PARAM

Key Datatype Required Description 
limit
number Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
sorters
string Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq*



HEADERS

Curl
curl -X GET 'https://tenant.api.identitynow.com/v3/non-employee-records?limit=250&offset=0&count=true&sorters=accountName,sourceId&filters=sourceId eq "2c91808568c529c60168cca6f90c1313"' -H 'Accept: application/json'

ENDPOINTS

    Key Datatype Required Description 
    Accept