Skip to content

All Identities

Endpoint: GET /api/identities

Description: Returns a paginated list of all identities, ordered by last name then first name.

Query Parameters

Parameter Type Required Description
page integer No Page number (1-based). Default: 1.

Response Attributes

Field Type Description
items array[object] The result set for the current page.
items[].id string (GUID) Unique identifier of the identity.
items[].kind string Resource type. Always Identity.
items[].firstName string First name.
items[].lastName string Last name.
items[].emailAddress string Email address.
items[].type string Identity type. Values: Employee, Service Account, Vendor, Shared, Mailbox, Client, Temporary, Administrator, Auditor, Unknown.
items[].title string Job title.
items[].company string Company name.
items[].division string Division name.
items[].department string Department name.
items[].office string Office location.
items[].supervisorName string Display name of the supervisor.
items[].createdDate string (ISO 8601) Date the identity record was originally created in the source system.
items[].updatedDate string (ISO 8601) Date the identity record was last updated in the source system.
items[].firstSeenDate string (ISO 8601) Date the identity was first imported into Permission Assist.
items[].inactivatedDate string (ISO 8601) Date the identity was deactivated. null if active.
items[].status string Current status. Values: Active, Disabled, Removed.
totalCount integer Total matching results across all pages.
page integer Current page number.
pageSize integer Number of results per page. Always 50.
totalPages integer Total number of pages.

Sample Response

{
  "items": [
    {
      "id": "d4a7e2b1-3f5c-4a8d-9e6b-1c2d3e4f5a6b",
      "kind": "Identity",
      "firstName": "Sarah",
      "lastName": "Chen",
      "emailAddress": "schen@firstbankofvalkyrie.com",
      "type": "Employee",
      "title": "Senior Loan Officer",
      "company": "First Bank of Valkyrie",
      "division": "Commercial Lending",
      "department": "Business Loans",
      "office": "Fargo Main",
      "supervisorName": "Martinez, Robert",
      "createdDate": "2023-03-15T14:30:00Z",
      "updatedDate": "2025-11-20T09:15:00Z",
      "firstSeenDate": "2023-03-16T02:00:00Z",
      "inactivatedDate": null,
      "status": "Active"
    }
  ],
  "totalCount": 142,
  "page": 1,
  "pageSize": 50,
  "totalPages": 3
}