Openpath orgs/entries API

Entries and Entry Hardware

Operations 35

GET /orgs/{orgId}/entries List all entries #
POST /orgs/{orgId}/entries Create an entry #
GET /orgs/{orgId}/entries/{entryId} Describe an entry #
DELETE /orgs/{orgId}/entries/{entryId} Delete an entry #
PATCH /orgs/{orgId}/entries/{entryId} Update an entry #
GET /orgs/{orgId}/entries/{entryId}/cameras List all cameras of an entry #
GET /orgs/{orgId}/entries/{entryId}/thirdPartWiegands List all third party reader - wiegands of an entry #
GET /orgs/{orgId}/entries/{entryId}/wiegands List all wiegands of an entry #
GET /orgs/{orgId}/entries/{entryId}/contactSensors List all contactSensors of an entry #
GET /orgs/{orgId}/entries/{entryId}/readers List all readers of an entry #
GET /orgs/{orgId}/entries/{entryId}/users List all active users that have access to an entry #
GET /orgs/{orgId}/entries/{entryId}/userSchedules List all active users, with their associated schedule(s), that have access to an entry #
GET /orgs/{orgId}/entries/{entryId}/relays List all relays of an entry #
GET /orgs/{orgId}/entries/{entryId}/rexs List all rexs of an entry #
GET /orgs/{orgId}/entries/{entryId}/thirdPartyReaders List all third party reader - OSDPs of an entry #
GET /orgs/{orgId}/entries/{entryId}/entryControls List all controls (readers, rexs, contact sensors, wiegands, relays) of an entry #
GET /orgs/{orgId}/entries/{entryId}/reports/activity Get an entry's activity #
POST /orgs/{orgId}/entries/list List all entries #
POST /orgs/{orgId}/entries/{entryId}/revertTempState Remove any temporary override state from the entry's schedule #
POST /orgs/{orgId}/entries/{entryId}/identify Remotely trigger an entry to identify itself via LED and buzzer of associated readers #
POST /orgs/{orgId}/entries/{entryId}/setTempState Add a temporary override state to the entry's schedule #
DELETE /orgs/{orgId}/entries/{entryId}/thirdPartyWiegands/{thirdPartyWiegandId} Remove a third party reader - wiegand from an entry #
PUT /orgs/{orgId}/entries/{entryId}/thirdPartyWiegands/{thirdPartyWiegandId} Set a third party reader - wiegand to an entry #
DELETE /orgs/{orgId}/entries/{entryId}/wiegands/{wiegandId} Remove a wiegand from an entry #
PUT /orgs/{orgId}/entries/{entryId}/wiegands/{wiegandId} Set a wiegand to an entry #
DELETE /orgs/{orgId}/entries/{entryId}/contactSensors/{contactSensorId} Remove a contactSensor from an entry #
PUT /orgs/{orgId}/entries/{entryId}/contactSensors/{contactSensorId} Set a contactSensor to an entry #
DELETE /orgs/{orgId}/entries/{entryId}/readers/{readerId} Remove a reader from an entry #
PUT /orgs/{orgId}/entries/{entryId}/readers/{readerId} Set a reader to an entry #
DELETE /orgs/{orgId}/entries/{entryId}/relays/{relayId} Remove a relay from an entry #
PUT /orgs/{orgId}/entries/{entryId}/relays/{relayId} Set a relay to an entry #
DELETE /orgs/{orgId}/entries/{entryId}/rexs/{rexId} Remove a rex from an entry #
PUT /orgs/{orgId}/entries/{entryId}/rexs/{rexId} Set a rex to an entry #
DELETE /orgs/{orgId}/entries/{entryId}/thirdPartyReaders/{thirdPartyReaderId} Remove a third party reader - OSDP from an entry #
PUT /orgs/{orgId}/entries/{entryId}/thirdPartyReaders/{thirdPartyReaderId} Set a third party reader - OSDP to an entry #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/openpath-orgs-entries-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openpath-orgs-entries-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Openpath API Documentation auth Orgs/entries API
  version: 1.0.0
  description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/entries
  description: Entries and Entry Hardware
paths:
  /orgs/{orgId}/entries:
    get:
      summary: List all entries
      operationId: listEntries
      description: 'Possible comma separated values for the options parameter include: withEffectiveLocationRestriction. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only entries with an effective location restriction include this object.<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-entryAccessAudit:w,o{params.orgId}-entryAccessAudit:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-account:w,o{params.orgId}-account:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-musterReport:w,o{params.orgId}-musterReport:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listEntries'
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: integer
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 1000
          minimum: 1
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
          minimum: 0
      - name: sort
        in: query
        schema:
          type: string
          default: name
          pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
      - name: order
        in: query
        schema:
          type: string
          default: asc
          pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
      - name: q
        in: query
        schema:
          type: string
      - name: filter
        in: query
        schema:
          type: string
      - name: preFilter
        in: query
        schema:
          type: string
      - name: options
        in: query
        schema:
          type: string
          pattern: ^((withEffectiveLocationRestriction)(,|$))*$
      tags:
      - orgs/entries
      security:
      - jwt: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalCount:
                    type: integer
                  filteredCount:
                    type: integer
                  cursors:
                    type: object
                    properties:
                      nextCursor:
                        type:
                        - integer
                        - 'null'
                        x-alternatives:
                        - type:
                          - integer
                          - 'null'
                        - type:
                          - string
                          - 'null'
                          pattern: ^[a-zA-Z0-9,@._~-]+$
                      hasNextPage:
                        type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        opal:
                          type: string
                        name:
                          type: string
                        isPincodeEnabled:
                          type: boolean
                        pincode:
                          type:
                          - string
                          - 'null'
                        acu:
                          type:
                          - object
                          - 'null'
                          properties:
                            id:
                              type: number
                            name:
                              type: string
                            isGatewayMode:
                              type:
                              - boolean
                              - 'null'
                          required:
                          - id
                        wirelessLock:
                          type:
                          - object
                          - 'null'
                          properties:
                            id:
                              type: number
                            name:
                              type: string
                            manufacturer:
                              type: string
                            model:
                              type: string
                            serialNumber:
                              type:
                              - string
                              - 'null'
                            idExt:
                              type:
                              - string
                              - 'null'
                            lastConnectedAt:
                              type:
                              - string
                              - 'null'
                              format: date
                            linkId:
                              type:
                              - string
                              - 'null'
                            config:
                              type:
                              - object
                              - 'null'
                              properties:
                                battV:
                                  type: object
                                  properties:
                                    main:
                                      type: string
                                    li:
                                      type: string
                                fwVer:
                                  type: object
                                  properties:
                                    lock:
                                      type: string
                                    main:
                                      type: string
                                    mainBl:
                                      type: string
                                    credRdr:
                                      type: string
                                    credRdrBl:
                                      type: string
                                    ble:
                                      type: string
                                    wifi:
                                      type: string
                                    macAdr:
                                      type: string
                                    recoveryFwVer:
                                      type: string
                                lockPrmtrs:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      minLength: 1
                                      maxLength: 52
                                    type:
                                      type: string
                                      enum:
                                      - strm
                                      - office
                                      - apt
                                      - prvcy
                                    relock:
                                      type: integer
                                      minimum: 0
                                      maximum: 30
                                    lockId:
                                      type: integer
                                    doorProp:
                                      type: integer
                                      minimum: 1
                                      maximum: 255
                                    ada:
                                      type: integer
                                      minimum: 1
                                      maximum: 255
                                    firstManIn:
                                      type: integer
                                      enum:
                                      - 0
                                      - 1
                                    battFail:
                                      type: string
                                      enum:
                                      - asIs
                                      - safe
                                      - sec
                                    blinkIntLed:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    rapidBlink:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    dstEnable:
                                      type: integer
                                      enum:
                                      - 0
                                      - 1
                                    dstStart:
                                      type: string
                                      x-constraint:
                                        length: 4
                                      x-convert:
                                        case: lower
                                    dstEnd:
                                      type: string
                                      x-constraint:
                                        length: 4
                                      x-convert:
                                        case: lower
                                    rtcTime:
                                      type: string
                                      x-constraint:
                                        length: 14
                                    wifiAlertEn:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    wifiAlertSel:
                                      type: array
                                      items:
                                        type: string
                                        x-constraint:
                                          length: 6
                                    fwUrl:
                                      type: string
                                      maxLength: 64
                                    fwDwnldTm:
                                      type: string
                                      x-constraint:
                                        length: 14
                                    fwImplTm:
                                      type: string
                                      x-constraint:
                                        length: 14
                                    dpsEn:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    bleCredEn:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    bleCredRng:
                                      type: string
                                      enum:
                                      - short
                                      - long
                                    blePerf:
                                      type: string
                                      enum:
                                      - norm
                                      - max
                                    invCrdAudEn:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    wifiDwnldRtyTmIntv:
                                      type: integer
                                      minimum: 5
                                      maximum: 1440
                                    wifiDwnldRtyCnt:
                                      type: integer
                                      minimum: 1
                                      maximum: 250
                                    auditIDEn:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    blkCnstr:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    mdl:
                                      type: string
                                    lckMode:
                                      type: string
                                    lckSn:
                                      type: string
                                    mainSn:
                                      type: string
                                    hwVer:
                                      type: string
                                    daysInUse:
                                      type: integer
                                    mfgDt:
                                      type: string
                                    dbDwnldTm:
                                      type: string
                                    fwImpTm:
                                      type: string
                                    nxtDbVerTS:
                                      type: string
                                    hwCfg:
                                      type: string
                                    dbUpdateStatus:
                                      type: integer
                                    wtyAct:
                                      type: string
                                      x-constraint:
                                        length: 14
                                      x-alternatives:
                                      - type: string
                                        x-constraint:
                                          length: 14
                                      - type: string
                                        enum:
                                        - unknown
                                    numCycles:
                                      type: integer
                                rdrPrmtrs:
                                  type: object
                                  properties:
                                    bprEn:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    rdrSense:
                                      type: string
                                      enum:
                                      - norm
                                      - high
                                      - max
                                    proxConfHID:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    proxConfGECASI:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    proxConfGE4001:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    proxConfGE4002:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    proxConfAWID:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    uid14443:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    mi14443:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    mip14443:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    noc14443:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    uid15693:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    iClsUID40b:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    iClsFrmt:
                                      type: string
                                      enum:
                                      - disbld
                                      - 64bCSN
                                    daysInUse:
                                      type: integer
                                    sn:
                                      type: string
                                    hwVer:
                                      type: string
                                    mfgDt:
                                      type: string
                                    configCrdPrsntd:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    customKeyPrsntd:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                dvcProfile:
                                  type: object
                                  properties:
                                    baseType:
                                      type: string
                                    ext:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          key:
                                            type: string
                                          value:
                                            type: integer
                                            enum:
                                            - 1
                                            - 0
                            status:
                              type:
                              - object
                              - 'null'
                              properties:
                                lockStatus:
                                  type: object
                                  properties:
                                    currentLockState:
                                      type: string
                                sensorStatus:
                                  type: object
                                  properties:
                                    locked:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    auxPosition:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    alarmPosition:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    lockClutched:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    primaryBatteryStatus:
                                      type: string
                                    rtcBatteryStatus:
                                      type: string
                                    rtccStatus:
                                      type: string
                                    doorOpen:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    ipbActive:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    rexActive:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    renActive:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    relActive:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    deadBoltExtended:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    keyOverrideActive:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    fdrActive:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    tamperOpen:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    magTamperDetected:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    rdrTamperDetected:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    ttl1Active:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    ttl2Active:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    bprActive:
                                      type: string
                                      enum:
                                      - T
                                      - F
                                    ledActive:
                                      type: string
                                      enum:
                                      - T
                                      - F
                            commStatus:
                              type:
                              - string
                              - 'null'
                            batteryLevel:
                              type:
                              - number
                              - 'null'
                            updatedAt:
                              type: string
                              format: date
                            wirelessLockGatewayId:
                              type:
                              - integer
                              - 'null'
                            wirelessGatewayId:
                              type:
                              - integer
                              - 'null'
                            thirdPartyDevice:
                              type:
                              - object
                              - 'null'
                              properties:
                                id:
                                  type: integer
                                assignedOrg:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    name:
                                      type: string
                                  required:
                                  - id
                                serialNumber:
                                  type: string
                                isOpSourced:
                                  type: boolean
                                orderName:
                                  type:
                                  - string
                                  - 'null'
                                createdAt:
                                  type: string
                                  format: date
                                updatedAt:
                                  type: string
                                  format: date
                                thirdPartyDeviceType:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    manufacturerName:
                                      type: string
                                    hardwareModel:
                                      type: string
                                    description:
                                      type: string
                                    dbModelName:
                                      type: string
                                    createdAt:
                                      type: string
                                      format: date
                                    updatedAt:
                                      type: string
                                      format: date
                                  required:
                                  - id
                              required:
                              - id
                            allegionWirelessLock:
                              type:
                              - object
                              - 'null'
                              properties:
                                auditsLastSyncedAt:
                                  type:
                                  - string
                                  - 'null'
                                  format: date
                                batteryLevel:
                                  type:
                                  - number
                                  - 'null'
                                commStatus:
                                  type:
                                  - string
                                  - 'null'
                                config:
                                  type:
                                  - object
                                  - 'null'
                                  properties:
                                    battV:
                                      type: object
                                      properties:
                                        main:
                                          type: string
                                        li:
                                          type: string
                                    fwVer:
                                      type: object
                                      properties:
                                        lock:
                                          type: string
                                        main:
                                          type: string
                                        mainBl:
                                          type: string
                                        credRdr:
                                          type: string
                                        credRdrBl:
                                          type: string
                                        ble:
                                          type: string
                                        wifi:
                                          type: string
                                        macAdr:
                                          type: string
                                        recoveryFwVer:
                                          type: string
                                    lockPrmtrs:
                                      type: object
                                      properties:
                                        name:
                                          type: string
                                          minLength: 1
                                          maxLength: 52
                                        type:
                                          type: string
                                          enum:
                                          - strm
                                          - office
                                          - apt
                                          - prvcy
                                        relock:
                                          type: integer
                                          minimum: 0
                                          maximum: 30
                                        lockId:
                                          type: integer
                                        doorProp:
                                          type: integer
                                          minimum: 1
                                          maximum: 255
                                        ada:
                                          type: integer
               

# --- truncated at 32 KB (391 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-entries-api-openapi.yml