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-zones-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/zones API
version: 1.0.0
description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/zones
description: Zones
paths:
/orgs/{orgId}/zones:
get:
summary: List all owned or shared zones
operationId: listZones
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}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp: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}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o{params.orgId}-rpt:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listZones'
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
tags:
- orgs/zones
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: integer
opal:
type: string
name:
type: string
description:
type:
- string
- 'null'
org:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
site:
type:
- object
- 'null'
properties:
id:
type: integer
name:
type: string
required:
- id
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
apbResetIcalText:
type:
- string
- 'null'
apbExpirationSeconds:
type:
- integer
- 'null'
apbUseContactSensor:
type: boolean
apbAllowSharedOrgReset:
type: boolean
zoneShares:
type: array
items:
type: object
properties:
orgId:
type: integer
entries:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
acu:
type: object
properties:
id:
type: integer
required:
- id
wirelessLock:
type:
- object
- 'null'
properties:
id:
type: number
noTourLockId:
type:
- integer
- 'null'
minimum: 0
maximum: 65534
isOffline:
type: boolean
wirelessLockDbEntries:
type: array
items:
type: object
properties:
credentialNumberHash:
type: string
required:
- id
required:
- id
apbAreas:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
entryCount:
type: integer
offlineEntryCount:
type: integer
userCount:
type: integer
groupCount:
type: integer
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}-site:w
- o{params.orgId}-site:r
- o{params.orgId}-siteGeneral:w
- o{params.orgId}-siteGeneral:r
- o{params.orgId}-ldp:w
- o{params.orgId}-ldp: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}-musterReport:r
- o{params.orgId}-musterReport:w
- o{params.orgId}-occupancyReport:r
- o{params.orgId}-occupancyReport:w
- o{params.orgId}-rpt:r
- o:w
- o:r
- s-o:w
- s-o:r
post:
summary: Create a zone
operationId: createZone
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: createZone'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
tags:
- orgs/zones
security:
- jwt: []
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: integer
opal:
type: string
name:
type: string
description:
type:
- string
- 'null'
org:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
site:
type:
- object
- 'null'
properties:
id:
type: integer
name:
type: string
required:
- id
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
apbResetIcalText:
type:
- string
- 'null'
apbExpirationSeconds:
type:
- integer
- 'null'
apbUseContactSensor:
type: boolean
apbAllowSharedOrgReset:
type: boolean
zoneShares:
type: array
items:
type: object
properties:
orgId:
type: integer
entries:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
acu:
type: object
properties:
id:
type: integer
required:
- id
wirelessLock:
type:
- object
- 'null'
properties:
id:
type: number
noTourLockId:
type:
- integer
- 'null'
minimum: 0
maximum: 65534
isOffline:
type: boolean
wirelessLockDbEntries:
type: array
items:
type: object
properties:
credentialNumberHash:
type: string
required:
- id
required:
- id
apbAreas:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
entryCount:
type: integer
offlineEntryCount:
type: integer
userCount:
type: integer
groupCount:
type: integer
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}-site:w
- o{params.orgId}-siteGeneral: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
siteId:
type: integer
description:
type:
- string
- 'null'
apbResetIcalText:
type:
- string
- 'null'
apbExpirationSeconds:
type:
- integer
- 'null'
apbUseContactSensor:
type: boolean
default: true
apbAllowSharedOrgReset:
type: boolean
default: false
required:
- name
- siteId
/orgs/{orgId}/zones/{zoneId}:
get:
summary: Describe an owned or shared zone
operationId: describeZone
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}-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__: describeZone'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: zoneId
in: path
required: true
schema:
type: integer
tags:
- orgs/zones
security:
- jwt: []
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: integer
opal:
type: string
name:
type: string
description:
type:
- string
- 'null'
org:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
site:
type:
- object
- 'null'
properties:
id:
type: integer
name:
type: string
required:
- id
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
apbResetIcalText:
type:
- string
- 'null'
apbExpirationSeconds:
type:
- integer
- 'null'
apbUseContactSensor:
type: boolean
apbAllowSharedOrgReset:
type: boolean
zoneShares:
type: array
items:
type: object
properties:
orgId:
type: integer
entries:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
acu:
type: object
properties:
id:
type: integer
required:
- id
wirelessLock:
type:
- object
- 'null'
properties:
id:
type: number
noTourLockId:
type:
- integer
- 'null'
minimum: 0
maximum: 65534
isOffline:
type: boolean
wirelessLockDbEntries:
type: array
items:
type: object
properties:
credentialNumberHash:
type: string
required:
- id
required:
- id
apbAreas:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
entryCount:
type: integer
offlineEntryCount:
type: integer
userCount:
type: integer
groupCount:
type: integer
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}-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
delete:
summary: Delete a zone
operationId: deleteZone
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteZone'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: zoneId
in: path
required: true
schema:
type: integer
tags:
- orgs/zones
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-site:w
- o{params.orgId}-site:w
- o{params.orgId}-siteGeneral:w
- o{params.orgId}-siteGeneral:w
- o:w
- s-o:w
patch:
summary: Update a zone
operationId: updateZone
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateZone'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: zoneId
in: path
required: true
schema:
type: integer
tags:
- orgs/zones
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-site:w
- o{params.orgId}-siteGeneral: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
description:
type:
- string
- 'null'
siteId:
type: integer
apbResetIcalText:
type:
- string
- 'null'
apbExpirationSeconds:
type:
- integer
- 'null'
apbUseContactSensor:
type: boolean
apbAllowSharedOrgReset:
type: boolean
/orgs/{orgId}/zones/{zoneId}/apbAreas:
get:
summary: List all zone anti-passback areas
operationId: listZoneApbAreas
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listZoneApbAreas'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: zoneId
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
tags:
- orgs/zones
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: integer
name:
type: string
occupancyLimit:
type:
- integer
- 'null'
occupancyLimitMode:
type:
- string
- 'null'
enum:
- alert
- enforce
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
apbFlows:
type: array
items:
type: object
properties:
id:
type: integer
direction:
type: string
enum:
- inbound
- outbound
mode:
type:
- string
- 'null'
enum:
- alert
- enforce
entries:
type: array
items:
type: object
properties:
id:
type: integer
required:
- id
required:
- id
- direction
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}-site:w
- o{params.orgId}-site:r
- o{params.orgId}-siteGeneral:w
- o{params.orgId}-siteGeneral:r
- o{params.orgId}-dash:w
- o{params.orgId}-dash:r
- o{params.orgId}-dashActivity:w
- o{params.orgId}-dashActivity:r
- o:w
- o:r
- s-o:w
- s-o:r
post:
summary: Create a zone anti-passback area
operationId: createZoneApbArea
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createZoneApbArea'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: zoneId
in: path
required: true
schema:
type: integer
tags:
- orgs/zones
security:
- jwt: []
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
data:
type: object
# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-zones-api-openapi.yml