Openpath orgs/credentialTypes API

Credential Types

Operations 6

GET /orgs/{orgId}/credentialTypes List all credential types #
GET /orgs/{orgId}/credentialTypes/{credentialTypeId} Describe a credential type #
GET /orgs/{orgId}/credentialTypes/{credentialTypeId}/models/{modelId}/noTourCredentialCommands List all no tour credential commands for the given credential #
PUT /orgs/{orgId}/credentialTypes/{credentialTypeId}/models/{modelId}/noTourCredentialCommands Set the no tour credential commands for a credential #
GET /orgs/{orgId}/credentialTypes/{credentialTypeId}/models/{modelId}/targetOfNoTourCredentialCommands List all no tour credential commands for which the given credential is the target #
POST /orgs/{orgId}/credentialTypes/{credentialTypeId}/noTourCredentialSectors/list List all no tour credential sectors needed for this 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-credentialtypes-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-credentialtypes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Openpath API Documentation auth Orgs/credential Types API
  version: 1.0.0
  description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/credentialTypes
  description: Credential Types
paths:
  /orgs/{orgId}/credentialTypes:
    get:
      summary: List all credential types
      operationId: listCredentialTypes
      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}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:r,o{params.orgId}-rptGeneral:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listCredentialTypes'
      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: ordinal
          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/credentialTypes
      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
                        description:
                          type: string
                        modelName:
                          type: string
                      required:
                      - id
                  meta:
                    type: object
                    properties:
                      accessToken:
                        type:
                        - object
                        - 'null'
                        properties:
                          scopeUpdatedAt:
                            type: string
                            format: date
                      siteSpecificAccess:
                        type:
                        - object
                        - 'null'
                        properties:
                          isSiteSpecific:
                            type: boolean
                          siteIds:
                            type:
                            - array
                            - 'null'
                            items:
                              type: integer
                          siteIdsByScope:
                            type:
                            - object
                            - 'null'
                            properties:
                              string:
                                type:
                                - array
                                - 'null'
                                items:
                                  type: integer
      x-op-scopes:
      - o{params.orgId}-user:w
      - o{params.orgId}-user:r
      - o{params.orgId}-dash:w
      - o{params.orgId}-dash:r
      - o{params.orgId}-dashActivity:w
      - o{params.orgId}-dashActivity:r
      - o{params.orgId}-dashCust:w
      - o{params.orgId}-dashCust:r
      - o{params.orgId}-credential:w
      - o{params.orgId}-credential:r
      - o{params.orgId}-rpt:r
      - o{params.orgId}-rpt:w
      - o{params.orgId}-rptGeneral:r
      - o{params.orgId}-rptGeneral:w
      - o:w
      - o:r
      - s-o:w
      - s-o:r
  /orgs/{orgId}/credentialTypes/{credentialTypeId}:
    get:
      summary: Describe a credential type
      operationId: describeCredentialType
      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:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeCredentialType'
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: integer
      - name: credentialTypeId
        in: path
        required: true
        schema:
          type: integer
      tags:
      - orgs/credentialTypes
      security:
      - jwt: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: number
                      name:
                        type: string
                      description:
                        type: string
                      modelName:
                        type: string
                    required:
                    - id
                  meta:
                    type: object
                    properties:
                      accessToken:
                        type:
                        - object
                        - 'null'
                        properties:
                          scopeUpdatedAt:
                            type: string
                            format: date
                      siteSpecificAccess:
                        type:
                        - object
                        - 'null'
                        properties:
                          isSiteSpecific:
                            type: boolean
                          siteIds:
                            type:
                            - array
                            - 'null'
                            items:
                              type: integer
                          siteIdsByScope:
                            type:
                            - object
                            - 'null'
                            properties:
                              string:
                                type:
                                - array
                                - 'null'
                                items:
                                  type: integer
      x-op-scopes:
      - o{params.orgId}-user:w
      - o{params.orgId}-user:r
      - o:w
      - o:r
      - s-o:w
      - s-o:r
  /orgs/{orgId}/credentialTypes/{credentialTypeId}/models/{modelId}/noTourCredentialCommands:
    get:
      summary: List all no tour credential commands for the given credential
      operationId: listOrgNoTourCredentialCommands
      description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-credential:w,o{params.orgId}-credential:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listOrgNoTourCredentialCommands'
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: integer
      - name: credentialTypeId
        in: path
        required: true
        schema:
          type: integer
      - name: modelId
        in: path
        required: true
        schema:
          type: integer
      tags:
      - orgs/credentialTypes
      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
                        command:
                          type: string
                          enum:
                          - ADD
                          - DEL
                        fobAllegion:
                          type:
                          - object
                          - 'null'
                          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
                                              rtccSta

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