Skip to main content

Get identifiers by type (single or list)​

Returns either:

  • a paginated list of identifiers of the specified type (if number is not provided)
  • a single identifier matching the specified type and number (if number is provided)

The number parameter is validated according to the selected identifier type. For Wiegand-based identifiers, both HEX and Decimal formats are supported.

identifier_number in the response is returned in HEX or Decimal format depending on the selected Wiegand Identifier representation mode.

Query Parameters
  • type string required

    Possible values: [card, face_id, inputCode, qr, ukey, license_plate]

    Identifier type

  • number object

    Required only for single identifier operations and optional for batch operations

  • limit integer

    Possible values: [10, 20, 30, 50]

    Number of items. Value by default is 10

  • page_number integer

    Possible values: >= 1

    Page number

  • sort_type string

    Possible values: [asc, desc]

    Default value: asc

    Sort type (asc/desc)

Responses

Successfully returned identifier information.

Schema
    oneOf
  • list_items object[]

    List of identifiers

  • valid object

    Time validity settings for the identifier

  • time object

    Time validity model for identifier

    oneOf
  • is_permanent boolean

    Possible values: [true]

    Always true for permanent validity

  • passes object

    Pass limit model for identifier

    oneOf
  • is_permanent boolean

    Possible values: [true]

    Permanent mode flag

  • max_passes integer

    Maximum number of allowed passes

  • time_profiles object

    Time profiles that define when the identifier is allowed to be used

  • count integer

    Number of assigned time profiles

  • uid_items integer[]

    List of internal time profile unique identifiers

  • link_ids string[]

    List of external time profile identifiers used for configuration and synchronization

  • identifier_number object

    Identifier number in HEX or Decimal format depending on the selected Wiegand Identifier representation mode.

    Warning: The same value may represent different identifiers in different modes. For example, 44 is identifier 44 in Decimal mode, but identifier 68 in Decimal representation when HEX mode is used (0x44).

    Ensure the correct representation mode is selected before performing update or delete operations.

    oneOf
  • string
  • additional object

    Additional identifier metadata and implementation-specific properties

  • identifier_owner object

    Owner associated with the identifier

  • type string

    Owner entity type

  • name string

    Owner name or identifier

  • lock string

    Possible values: [first, second, all]

    Defines which lock the identifier grants access to:

    • first - access to the first lock only
    • second - access to the second lock only
    • all - access to both locks
  • apartment object

    Apartment associated with the identifier

  • uid integer

    Internal apartment identifier. Value -1 means that no apartment is assigned

  • identifier_type string

    Possible values: [card, face_id, inputCode, qr, ukey, license_plate]

    Identifier type

  • identifier_uid integer

    Unique identifier ID

  • list_option object

    Pagination, filtering and sorting metadata for list responses

  • pagination object

    Pagination information

  • total_items integer

    The total number of items found and reflected across all pages

  • items_limit integer

    Possible values: [10, 20, 30, 50]

    Limiting the display of the amount of data for one page

  • total_pages integer

    The number of pages that hold the requested data

  • current_page integer

    Possible values: >= 1

    Current page number

  • filter object

    Applied filters for identifier query

    anyOf
  • filter_field string

    Field available for filtering

  • filter_type string

    Possible values: [equal]

    Available filtering type, only equal here

  • filter_format string

    Data format, only string here

  • filter_value string

    Identifier name

  • sort object

    Sorting configuration used for response

  • field string

    Sorting field name

  • asc boolean

    Sort direction

  • available_fields string[]

    Available for sorting fields names

Loading...