Skip to main content

List Non-Employee Records

GET 

/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

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    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.

    Example: true
    sorters comma-separated

    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

    Example: accountName,sourceId
    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

    Example: sourceId eq "2c91808568c529c60168cca6f90c1313"

Responses

Non-Employee record objects

Schema

  • Array [

  • id UUID

    Non-Employee record id.

    accountName string

    Requested identity account name.

    firstName string

    Non-Employee's first name.

    lastName string

    Non-Employee's last name.

    email string

    Non-Employee's email.

    phone string

    Non-Employee's phone.

    manager string

    The account ID of a valid identity to serve as this non-employee's manager.

    sourceId string

    Non-Employee's source id.

    data

    object

    Attribute blob/bag for a non-employee.

    property name* string
    startDate date-time

    Non-Employee employment start date.

    endDate date-time

    Non-Employee employment end date.

    modified date-time

    When the request was last modified.

    created date-time

    When the request was created.

  • ]

Loading...