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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/openpath-orgs-readers-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
openapi: 3.2.0
info:
title: Openpath API Documentation auth Orgs/readers API
version: 1.0.0
description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/readers
description: Readers
paths:
/orgs/{orgId}/readers:
get:
summary: List all owned or assigned readers
operationId: listReaders
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 readers 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}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listReaders'
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|excludeVideoReaders|onlyVideoReaders)(,|$))*$
tags:
- orgs/readers
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
serialNumber:
type:
- string
- 'null'
serialNumberBrief:
type:
- string
- 'null'
firmwareVersion:
type:
- string
- 'null'
softwareVersionNumber:
type:
- string
- 'null'
isExit:
type: boolean
advTxPower:
type: number
enum:
- 4
- 3
- 0
- -4
- -8
- -12
- -16
- -20
- -40
beaconTxPower:
type: number
enum:
- 4
- 3
- 0
- -4
- -8
- -12
- -16
- -20
- -40
capTouchEnabled:
type: boolean
capTouchRssi:
type: integer
minimum: -95
maximum: -20
capTouchThreshold:
type:
- integer
- 'null'
nfcEnabled:
type: boolean
autoUnlockEnabled:
type: boolean
autoUnlockRssi:
type: integer
minimum: -95
maximum: -30
acuPort:
type:
- object
- 'null'
properties:
id:
type: number
acuPortTypePortNumber:
type: number
virtualPortNumber:
type:
- number
- 'null'
portNumber:
type:
- number
- 'null'
label:
type: string
acu:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
expansionBoard:
type: object
properties:
id:
type: number
number:
type: integer
acuModelId:
type: integer
required:
- id
eol:
type:
- object
- 'null'
properties:
eolSupervision:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
entries:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
org:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
ownedByOrg:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
effectiveLocationRestriction:
type: object
properties:
id:
type: integer
locationMeasurement:
type: object
properties:
longitude:
type: number
latitude:
type: number
timeZoneId:
type:
- string
- 'null'
allowedDistanceMeters:
type: number
scaleFactor:
type: number
required:
- id
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
notes:
type:
- string
- 'null'
isAudibleFeedbackEnabled:
type: boolean
isLedFeedbackEnabled:
type: boolean
pinTimeoutSeconds:
type: integer
isAppleWalletTraEnabled:
type: boolean
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}-dash:w
- o{params.orgId}-dash:r
- o{params.orgId}-hw:w
- o{params.orgId}-hw:r
- o{params.orgId}-site:w
- o{params.orgId}-site:r
- o{params.orgId}-siteGeneral:w
- o{params.orgId}-siteGeneral:r
- o{params.orgId}-admin:w
- o{params.orgId}-admin:r
- o{params.orgId}-quickStart:w
- o{params.orgId}-quickStart:r
- o{params.orgId}-rpt:r
- o{params.orgId}-rpt:w
- o:w
- o:r
- s-o:w
- s-o:r
post:
summary: Create a reader
operationId: createReader
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: createReader'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
tags:
- orgs/readers
security:
- jwt: []
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
name:
type: string
serialNumber:
type:
- string
- 'null'
serialNumberBrief:
type:
- string
- 'null'
firmwareVersion:
type:
- string
- 'null'
softwareVersionNumber:
type:
- string
- 'null'
isExit:
type: boolean
advTxPower:
type: number
enum:
- 4
- 3
- 0
- -4
- -8
- -12
- -16
- -20
- -40
beaconTxPower:
type: number
enum:
- 4
- 3
- 0
- -4
- -8
- -12
- -16
- -20
- -40
capTouchEnabled:
type: boolean
capTouchRssi:
type: integer
minimum: -95
maximum: -20
capTouchThreshold:
type:
- integer
- 'null'
nfcEnabled:
type: boolean
autoUnlockEnabled:
type: boolean
autoUnlockRssi:
type: integer
minimum: -95
maximum: -30
acuPort:
type:
- object
- 'null'
properties:
id:
type: number
acuPortTypePortNumber:
type: number
virtualPortNumber:
type:
- number
- 'null'
portNumber:
type:
- number
- 'null'
label:
type: string
acu:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
expansionBoard:
type: object
properties:
id:
type: number
number:
type: integer
acuModelId:
type: integer
required:
- id
eol:
type:
- object
- 'null'
properties:
eolSupervision:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
entries:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
org:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
ownedByOrg:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
effectiveLocationRestriction:
type: object
properties:
id:
type: integer
locationMeasurement:
type: object
properties:
longitude:
type: number
latitude:
type: number
timeZoneId:
type:
- string
- 'null'
allowedDistanceMeters:
type: number
scaleFactor:
type: number
required:
- id
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
notes:
type:
- string
- 'null'
isAudibleFeedbackEnabled:
type: boolean
isLedFeedbackEnabled:
type: boolean
pinTimeoutSeconds:
type: integer
isAppleWalletTraEnabled:
type: boolean
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}-hw:w
- o{params.orgId}-admin:w
- o{params.orgId}-quickStart:w
- o:w
- s-o:w
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 100
x-convert:
trim: true
notes:
type:
- string
- 'null'
serialNumber:
type:
- string
- 'null'
softwareVersionNumber:
type:
- string
- 'null'
acuPortId:
type:
- integer
- 'null'
isExit:
type: boolean
advTxPower:
type: integer
enum:
- 4
- 3
- 0
- -4
- -8
- -12
- -16
- -20
- -40
beaconTxPower:
type: integer
enum:
- 4
- 3
- 0
- -4
- -8
- -12
- -16
- -20
- -40
capTouchEnabled:
type: boolean
capTouchRssi:
type: integer
minimum: -95
maximum: -20
capTouchThreshold:
type:
- integer
- 'null'
minimum: 100
maximum: 15000
nfcEnabled:
type: boolean
autoUnlockEnabled:
type: boolean
autoUnlockRssi:
type: integer
minimum: -95
maximum: -30
isAudibleFeedbackEnabled:
type: boolean
isLedFeedbackEnabled:
type: boolean
pinTimeoutSeconds:
type: integer
isAppleWalletTraEnabled:
type: boolean
required:
- name
/orgs/{orgId}/readers/{readerId}:
get:
summary: Describe an owned or assigned reader
operationId: describeReader
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 readers 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}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeReader'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: readerId
in: path
required: true
schema:
type: integer
- name: options
in: query
schema:
type: string
pattern: ^((withEffectiveLocationRestriction)(,|$))*$
tags:
- orgs/readers
security:
- jwt: []
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
name:
type: string
serialNumber:
type:
- string
- 'null'
serialNumberBrief:
type:
- string
- 'null'
firmwareVersion:
type:
- string
- 'null'
softwareVersionNumber:
type:
- string
- 'null'
isExit:
type: boolean
advTxPower:
type: number
enum:
- 4
- 3
- 0
- -4
- -8
- -12
- -16
- -20
- -40
beaconTxPower:
type: number
enum:
- 4
- 3
- 0
- -4
- -8
- -12
- -16
- -20
- -40
capTouchEnabled:
type: boolean
capTouchRssi:
type: integer
minimum: -95
maximum: -20
capTouchThreshold:
type:
- integer
- 'null'
nfcEnabled:
type: boolean
autoUnlockEnabled:
type: boolean
autoUnlockRssi:
type: integer
minimum: -95
maximum: -30
acuPort:
type:
- object
- 'null'
properties:
id:
type: number
acuPortTypePortNumber:
type: number
virtualPortNumber:
type:
- number
- 'null'
portNumber:
type:
- number
- 'null'
label:
type: string
acu:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
expansionBoard:
type: object
properties:
id:
type: number
number:
type: integer
acuModelId:
type: integer
required:
- id
eol:
type:
- object
- 'null'
properties:
eolSupervision:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
entries:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
org:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
ownedByOrg:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
effectiveLocationRestriction:
type: object
properties:
id:
type: integer
locationMeasurement:
type: object
properties:
longitude:
type: number
latitude:
type: number
timeZoneId:
type:
- string
- 'null'
allowedDistanceMeters:
type: number
scaleFactor:
type: number
required:
- id
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
notes:
type:
- string
- 'null'
isAudibleFeedbackEnabled:
type: boolean
isLedFeedbackEnabled:
type: boolean
pinTimeoutSeconds:
type: integer
isAppleWalletTraEnabled:
type: boolean
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
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-readers-api-openapi.yml