> ## Documentation Index
> Fetch the complete documentation index at: https://integrate.essentry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Permanent Identities



## OpenAPI

````yaml api-reference/openapi.yaml get /permanent-identities
openapi: 3.0.0
info:
  title: essentry API
  version: 0.0.0
servers:
  - url: https://app.essentry.com/api/v2
    description: essentry Cloud
    variables: {}
security:
  - BearerAuth: []
tags:
  - name: Pre-Processor
  - name: User Provisioning
  - name: Permanent Identities
  - name: Access Control
  - name: Post-Processor
paths:
  /permanent-identities:
    get:
      tags:
        - Permanent Identities
      summary: Get Permanent Identities
      operationId: PermanentIdentities_getPermanentIdentities
      parameters:
        - $ref: '#/components/parameters/Pagination.limit'
        - $ref: '#/components/parameters/Pagination.offset'
        - name: updatedSince
          in: query
          required: false
          schema:
            type: string
            format: date-time
          explode: false
        - name: companyId
          in: query
          required: false
          description: >-
            Landlord tokens may filter to one tenant company; without it,
            everything the token sees is returned.
          schema:
            type: integer
          explode: false
        - name: sourceId
          in: query
          required: false
          schema:
            type: string
          explode: false
        - name: include
          in: query
          required: false
          description: Expensive; omitted by default.
          schema:
            type: array
            items:
              type: string
              enum:
                - accessControl.credentials
                - accessControl.profiles
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  permanentIdentities:
                    type: array
                    items:
                      $ref: '#/components/schemas/PermanentIdentity'
                  pageInfo:
                    type: object
                    properties:
                      totalCount:
                        type: integer
                    required:
                      - totalCount
                required:
                  - permanentIdentities
                  - pageInfo
components:
  parameters:
    Pagination.limit:
      name: limit
      in: query
      required: false
      description: Pagination - How many results to return
      schema:
        type: integer
        maximum: 50
        default: 20
      explode: false
    Pagination.offset:
      name: offset
      in: query
      required: false
      description: Pagination - How many results to skip
      schema:
        type: integer
        default: 0
      explode: false
  schemas:
    PermanentIdentity:
      type: object
      required:
        - sourceId
        - email
        - firstName
        - lastName
        - customFields
        - company
        - createdAt
        - updatedAt
        - startsAt
        - endsAt
      properties:
        sourceId:
          type: string
          nullable: true
          description: >-
            This is the ID in your system, e.g. an employee number. Unique per
            company. Null until a system claims the identity.
        email:
          type: string
          nullable: true
        firstName:
          type: string
        lastName:
          type: string
        companyName:
          type: string
        language:
          $ref: '#/components/schemas/GuestLanguage'
        customFields:
          type: object
          additionalProperties: {}
        company:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
          required:
            - id
            - name
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        startsAt:
          type: string
          format: date-time
        endsAt:
          type: string
          format: date-time
          nullable: true
          description: Null means no end date (indefinite).
        accessControl:
          type: object
          properties:
            credentials:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  cardNumberKiosk:
                    type: string
                  cardNumberReception:
                    type: string
                  cardNumberAccessControlSystem:
                    type: string
                required:
                  - id
                  - cardNumberKiosk
                  - cardNumberReception
                  - cardNumberAccessControlSystem
              description: >-
                Only returned when requested via
                include=accessControl.credentials.
            profiles:
              type: array
              items:
                type: object
                properties:
                  sourceId:
                    type: string
                  name:
                    type: string
                  accessProfileGroup:
                    type: object
                    properties:
                      sourceId:
                        type: string
                      name:
                        type: string
                    required:
                      - sourceId
                      - name
                  startsAt:
                    type: string
                    format: date-time
                  endsAt:
                    type: string
                    format: date-time
                required:
                  - sourceId
                  - name
                  - accessProfileGroup
              description: Only returned when requested via include=accessControl.profiles.
    GuestLanguage:
      type: string
      enum:
        - CS
        - DE
        - EN
        - ES
        - FR
        - HR
        - HU
        - IT
        - NL
        - PL
        - PT
        - RO
        - RU
        - TR
        - ZH_CN
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````