How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Openpath orgs/zones API is one of 89 APIs that Openpath publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include orgs/zones. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 31 operations across 18 paths. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://api.openpath.com.

31 operations 18 paths 0 schemas 4 DELETE10 GET4 PATCH6 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://api.openpath.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Openpath orgs/zones API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (jwt).

Paths & Operations 31

Across 18 paths, the API surfaces 31 operations — 4 DELETE, 10 GET, 4 PATCH, 6 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

orgs/zones 31

Zones

GET
/orgs/{orgId}/zones
List all owned or shared zones
listZones 8 params → 200
POST
/orgs/{orgId}/zones
Create a zone
createZone 2 params → 201
GET
/orgs/{orgId}/zones/{zoneId}
Describe an owned or shared zone
describeZone 2 params → 200
DELETE
/orgs/{orgId}/zones/{zoneId}
Delete a zone
deleteZone 2 params → 204
PATCH
/orgs/{orgId}/zones/{zoneId}
Update a zone
updateZone 3 params → 204
GET
/orgs/{orgId}/zones/{zoneId}/apbAreas
List all zone anti-passback areas
listZoneApbAreas 9 params → 200
POST
/orgs/{orgId}/zones/{zoneId}/apbAreas
Create a zone anti-passback area
createZoneApbArea 3 params → 201
GET
/orgs/{orgId}/zones/{zoneId}/groupIds
List all group IDs of a zone
listZoneGroupIds 2 params → 200
PUT
/orgs/{orgId}/zones/{zoneId}/groupIds
Set a zone's groups by replacing the entire set with this one
setZoneGroupIds 3 params → 204
GET
/orgs/{orgId}/zones/{zoneId}/zoneUsers
List all users (and their associated configurations) of a zone
listZoneZoneUsers 9 params → 200
PATCH
/orgs/{orgId}/zones/{zoneId}/zoneUsers
Bulk-update a zone's users (and their associated configurations)
updateZoneZoneUsers 3 params → 204
PUT
/orgs/{orgId}/zones/{zoneId}/zoneUsers
Set a zone's users (and their associated configurations) by replacing the entire set with this one
setZoneZoneUsers 3 params → 204
GET
/orgs/{orgId}/zones/{zoneId}/users
List all users of a zone
listZoneUsers 10 params → 200
GET
/orgs/{orgId}/zones/{zoneId}/shares
List all shares of this zone
listZoneShares 2 params → 200
GET
/orgs/{orgId}/zones/{zoneId}/groups
List all groups of a zone
listZoneGroups 10 params → 200
GET
/orgs/{orgId}/zones/{zoneId}/zoneGroups
List all groups (and their associated configurations) of a zone
listZoneZoneGroups 9 params → 200
PATCH
/orgs/{orgId}/zones/{zoneId}/zoneGroups
Bulk-update a zone's groups (and their associated configurations)
updateZoneZoneGroups 3 params → 204
PUT
/orgs/{orgId}/zones/{zoneId}/zoneGroups
Set a zone's groups (and their associated configurations) by replacing the entire set with this one
setZoneZoneGroups 3 params → 204
GET
/orgs/{orgId}/zones/{zoneId}/apbAreas/{apbAreaId}
Describe a zone anti-passback area
describeZoneApbArea 3 params → 200
DELETE
/orgs/{orgId}/zones/{zoneId}/apbAreas/{apbAreaId}
Delete a zone anti-passback area
deleteZoneApbArea 3 params → 204
PATCH
/orgs/{orgId}/zones/{zoneId}/apbAreas/{apbAreaId}
Update a zone anti-passback area
updateZoneApbArea 4 params → 204
POST
/orgs/{orgId}/zones/apbReset
Reset anti-passback for a zone and/or user
resetApb 2 params → 201
POST
/orgs/{orgId}/zones/{zoneId}/unshare
Unshare zone
unshareZone 3 params → 204
POST
/orgs/{orgId}/zones/{zoneId}/share
Share zone
shareZone 3 params → 204
POST
/orgs/{orgId}/zones/{zoneId}/relinquishShare
Relinquish shared zone from shared-to org
relinquishZoneShare 2 params → 204
DELETE
/orgs/{orgId}/zones/{zoneId}/users/{userId}
Remove a user from a zone
removeUserFromZone 3 params → 204
PUT
/orgs/{orgId}/zones/{zoneId}/users/{userId}
Add a user to a zone
setUserToZone 4 params → 204
DELETE
/orgs/{orgId}/zones/{zoneId}/groups/{groupId}
Remove a group from a zone
removeGroupFromZone 3 params → 204
PUT
/orgs/{orgId}/zones/{zoneId}/groups/{groupId}
Add a group to a zone
setGroupToZone 4 params → 204
PUT
/orgs/{orgId}/zones/{zoneId}/userIds
Set a zone's users by replacing the entire set with this one
setZoneUserIds 3 params → 204
PUT
/orgs/{orgId}/zones/{zoneId}/shareOrgIds
Set this zone's shares by replacing the entire set with this one
setZoneShareOrgIds 3 params → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openpath-orgs-zones-api-openapi.yml Raw ↑

Other APIs Openpath publishes across the network.

Openpath auth API
Openpath billableFeatures API
Openpath identities API
Openpath orgs/acuModels API
Openpath orgs/acuPorts API
Openpath orgs/acuPortTypes API
Openpath orgs/acus API
Openpath orgs/alarmActions API
Openpath orgs/alarmConfigurations API
Openpath orgs/alarmSeverities API
Openpath orgs/alarmsExt API
Openpath orgs/alarmStatuses API
Where this information came from

This is an independent, third-party profile of Openpath orgs/zones API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.