Openpath orgs/fobAllegions API

The orgs/fobAllegions API from Openpath — 2 operation(s) for orgs/foballegions.

Operations 4

GET /orgs/{orgId}/fobAllegions List all allegion fob credentials within the org #
POST /orgs/{orgId}/fobAllegions Create an allegion fob credential #
GET /orgs/{orgId}/fobAllegions/{fobAllegionId} Describe an allegion fob credential #
PATCH /orgs/{orgId}/fobAllegions/{fobAllegionId} Update an allegion fob credential #

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-foballegions-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-foballegions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Openpath API Documentation auth Orgs/fob Allegions API
  version: 1.0.0
  description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/fobAllegions
paths:
  /orgs/{orgId}/fobAllegions:
    get:
      summary: List all allegion fob credentials within the org
      operationId: listOrgFobAllegions
      description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgFobAllegions'
      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: id
          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
      tags:
      - orgs/fobAllegions
      security:
      - jwt: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalCount:
                    type: integer
                  filteredCount:
                    type: integer
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        name:
                          type: string
                        number:
                          type:
                          - string
                          - 'null'
                        csn:
                          type:
                          - string
                          - 'null'
                        isNoTour:
                          type: boolean
                        isLost:
                          type: boolean
                        userId:
                          type:
                          - integer
                          - 'null'
                        noTourCredentialCommands:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: number
                              command:
                                type: string
                                enum:
                                - ADD
                                - DEL
                              fobAllegionId:
                                type:
                                - integer
                                - 'null'
                              cardOpenpathDesfireEv1Id:
                                type:
                                - integer
                                - 'null'
                              allegionMobileId:
                                type:
                                - integer
                                - 'null'
                              wirelessLock:
                                type: object
                                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
                                  doorFileLastSyncedAt:
                                    type:
                                    - string
                                    - 'null'
                                    format: date
                                  auditsLastSyncedAt:
                                    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
                                  noTourLockId:
                                    type:
                                    - integer
                                    - 'null'
                                    minimum: 0
                                    maximum: 65535
                                  commStatus:
                                    type:
                                    - string
                                    - 'null'
                                  batteryLevel:
                                    type:
                                    - number
                                    - 'null'
                                  isOffline:
                                    type: boolean
                                  thirdPartyDeviceId:
                                    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
                                  acuId:
                                    type:
                                    - integer
                                    - 'null'
                                  acu:
                                    type:
                                    - object
                                    - 'null'
                                    properties:
                                      id:
                                        type: integer
                                      opal:
                                        type: string
                                      locationRestriction:
                                        type:
                                        - object
                                        - 'null'
                                        properties:
                                          id:
                                            type: number
                                          allowedDistanceMeters:
                              

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