Lists all the identities
GET {{baseUrl}}/historical-identities
This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read'
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
starts-with-query | string | This param is used for starts-with search for first, last and display name of the identity | |
is-deleted | boolean | Indicates if we want to only list down deleted identities or not. | |
is-active | boolean | Indicates if we want to only list active or inactive identities. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"bc693f07e7b645539626c25954c58554","displayName":"Adam Zampa","firstName":"Adam","lastName":"Zampa","active":true,"deletedDate":"2007-03-01T13:00:00.000Z"},{"id":"bc693f07e7b645539626c25954c58554","displayName":"Adam Zampa","firstName":"Adam","lastName":"Zampa","active":true,"deletedDate":"2007-03-01T13:00:00.000Z"}]