/
OP
openpath
/
Openpath API Documentation
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 1mo ago · Updated 1mo ago
Details
Filter operations
auth
10
get
Describe an access token's associated identity and scopes
post
Login
post
Login all successful matches for email/password
post
Logout
post
Send email to reset password
post
Send email with magic link to setup mobile
post
Create a new access token with refreshed scopes and expiration time, invalidate old token
post
DEPRECATED - use /auth/sso/authorize instead
post
Generate SSO authorize URL (may be OIDC or SAML)
post
Validate an access token for proper signature, format, expiration, and active status
billableFeatures
1
get
List all billable features
identities
2
get
List an identity's nicknames
patch
Bulk-update an identity's nicknames
orgs/acuModels
2
get
List all ACU models
get
Describe an ACU model
orgs/acuPorts
1
get
List all ACU ports
orgs/acuPortTypes
2
get
List all ACU port types
get
Describe an ACU port type
orgs/acus
36
get
List all owned or assigned ACUs
post
Create an ACU
get
Describe an owned or assigned ACU
delete
Delete an ACU
patch
Update an ACU
get
List ACU ports
get
Describe an owned or assigned ACU's timezone
get
List location measurements for an ACU
get
Get location restriction for an ACU
put
Set location restriction for an ACU
delete
Delete location restriction for an ACU
get
List all expansion boards belonging to an ACU
put
Set expansion boards for an ACU
post
Create an expansion board for an ACU
get
Describe an expansion board belonging to an ACU
delete
Delete an expansion board belonging to an ACU
patch
Update an expansion board belonging to an ACU
get
Describe a location measurement for an ACU
delete
Delete a location measurement for an ACU
get
Describe an ACU port
patch
Update an ACU port
get
Describe an ACU port's EOL settings
patch
Update an ACU port's EOL settings
post
Trigger a software update for ACUs
post
Run a command on an ACU
post
Remotely trigger an ACU to restart its hardware communicator
post
Remotely trigger an ACU to restart its API server
post
Remotely trigger an ACU to identify itself via LED
post
Trigger a software update for a single ACU
post
Remotely trigger an ACU to refresh its device shadow
post
Remotely trigger an ACU to restart its cloud communicator
put
ACU sets a location measurement for itself
put
Set a location measurement for an ACU
put
Set an ACU's status and nucleon config group name
get
Get ACU diagnostics report
post
Create an ACU diagnostics report
orgs/alarmActions
2
get
List all alarm actions
get
Describe an alarm action
orgs/alarmConfigurations
8
get
List all alarm configurations
post
Create an alarm configuration
get
Describe an alarm configuration
patch
Update an alarm configuration
get
List all cameras of an alarm configuration
put
Add a camera to an alarm configuration
delete
Remove a camera from an alarm configuration
put
Set an alarm configuration's cameras by replacing the entire set with this one
orgs/alarmSeverities
2
get
List all alarm severities
get
Describe an alarm severity
orgs/alarmsExt
3
get
Describe an alarm
patch
Update an alarm
patch
Bulk update alarms
orgs/alarmStatuses
2
get
List all alarm statuses
get
Describe an alarm status
orgs/authCerts
5
get
Get list of X.509 authentication certificates
post
Create an X.509 authentication certificate
get
Get an X.509 authentication certificate
delete
Delete an X.509 authentication certificate
patch
Update an X.509 authentication certificate
orgs/badgeConfigs
5
get
List all badge configs
post
Create a new badge config
get
Describe a badge config
delete
Delete a badge config of an Org
patch
Update a badge config
orgs/cardFormats
2
get
List all entry card formats
get
Describe a card format
orgs/cobalt
1
post
Receives a generateActivityLogsFilter request and passes it to cobalt to execute
orgs/contactSensors
3
get
List all contact sensors
get
Describe a contact sensor
patch
Update a contact sensor
orgs/credentialActionTypes
2
get
List all credential action types
get
Describe a credential action type
orgs/credentials
6
get
List all credentials from all users within the org
get
List all credential actions
post
Create a credential action
get
Describe a credential action
delete
Delete a credential action
patch
Update a credential action
orgs/credentialTypes
6
get
List all credential types
get
Describe a credential type
get
List all no tour credential commands for which the given credential is the target
get
List all no tour credential commands for the given credential
put
Set the no tour credential commands for a credential
post
List all no tour credential sectors needed for this credential
orgs/customFields
12
get
List all custom fields
post
Create a custom field
patch
Bulk update custom fields
get
Describe a custom field
delete
Delete a custom field
patch
Update a custom field
get
List all custom field dropdown items
post
Create a custom field dropdown item
patch
Bulk update custom field dropdown items
get
Describe a custom field dropdown item
delete
Delete a custom field dropdown item
patch
Update a custom field dropdown item
orgs/customFieldTypes
2
get
List all custom field types
get
Describe a custom field type
orgs/dashboards
10
get
List all dashboards
post
Create a new dashboard
get
Describe a dashboard
delete
Delete a dashboard
patch
Update an existing dashboard
get
List all dashboard widgets
post
Create a new dashboard widget
get
Describe a dashboard widget
delete
Delete a dashboard widget
patch
Update a dashboard widget
orgs/emailAlerts
1
get
Get email alerts
orgs/emailAlertTypes
2
get
List all email alert types
get
Describe an email alert type
orgs/entries
35
get
List all entries
post
Create an entry
get
Describe an entry
delete
Delete an entry
patch
Update an entry
get
List all cameras of an entry
get
List all third party reader - wiegands of an entry
get
List all wiegands of an entry
get
List all contactSensors of an entry
get
List all readers of an entry
get
List all active users that have access to an entry
get
List all active users, with their associated schedule(s), that have access to an entry
get
List all relays of an entry
get
List all rexs of an entry
get
List all third party reader - OSDPs of an entry
get
List all controls (readers, rexs, contact sensors, wiegands, relays) of an entry
get
Get an entry's activity
post
Remove any temporary override state from the entry's schedule
post
List all entries
post
Remotely trigger an entry to identify itself via LED and buzzer of associated readers
post
Add a temporary override state to the entry's schedule
put
Set a third party reader - OSDP to an entry
delete
Remove a third party reader - OSDP from an entry
put
Set a rex to an entry
delete
Remove a rex from an entry
put
Set a relay to an entry
delete
Remove a relay from an entry
put
Set a reader to an entry
delete
Remove a reader from an entry
put
Set a contactSensor to an entry
delete
Remove a contactSensor from an entry
put
Set a wiegand to an entry
delete
Remove a wiegand from an entry
put
Set a third party reader - wiegand to an entry
delete
Remove a third party reader - wiegand from an entry
orgs/entryStates
6
get
List all entry states
post
Create a custom entry state
get
Describe an entry state
delete
Delete a custom entry state
patch
Update a custom entry state
put
Set a custom entry state's entire list of trigger methods
orgs/eolSupervisions
2
get
List all EOL supervisions
get
Describe an EOL supervision
orgs/features
1
get
Get an organization's enabled features
orgs/fobAllegions
4
get
List all allegion fob credentials within the org
post
Create an allegion fob credential
get
Describe an allegion fob credential
patch
Update an allegion fob credential
orgs/genericInputs
3
get
List all generic inputs
get
Describe a generic input
patch
Update a generic input
orgs/groups
20
get
List all access groups
post
Create an access group
get
Describe an access group
delete
Delete an access group
patch
Update an access group
get
List all entries an access group has access to
get
List all zones of an access group
get
List all users of an access group
get
List all zones (and their associated configurations) an access group has access to
put
Set an access groups's zones (and their associated configurations) by replacing the entire set with this one
patch
Bulk-update an access groups's zones (and their associated configurations)
get
List all user IDs of a group
put
Set an access group's users by replacing the entire set with this one
patch
Bulk-update an access group's users
post
List all access groups
put
Add a user to an access group
delete
Remove a user from an access group
put
Set an access group's zones by replacing the entire set with this one
put
Set a group's sites by replacing the entire set with this one
patch
Bulk-update a group's sites
orgs/hookActions
5
get
List all hook actions
post
Create a hook action
get
Describe a hook action
delete
Delete a hook action
patch
Update a hook action
orgs/hookEvents
2
get
List all hook events
get
Describe a hook event
orgs/identityProviders
10
get
List all identity providers
get
Describe an identity provider
get
List an identity provider's groups
get
Describe an identity provider's group relations
put
Set an identity provider's group relations
post
Sync users
post
Generate OAuth2 authorize URL
put
Add a group relation to an identity provider
delete
Remove a group relation from an identity provider
put
Inactivate an identity provider and all associated identities and users
orgs/identityProviderTypes
2
get
List all identity provider types
get
Describe a identity provider type
orgs/ios
2
get
List all I/Os
get
Describe an I/O
orgs/locationMeasurementSourceTypes
2
get
List all location measurement source types
get
Describe a location measurement source type
orgs/lockdownPlans
7
get
List all lockdown plans
post
Create a lockdown plan
get
Describe a lockdown plan
delete
Delete a lockdown plan
patch
Update a lockdown plan
put
Set a lockdown plan's zone states
put
Set a lockdown plan's user and group permissions
orgs/mailrooms
8
get
List active mailrooms
post
Create a mailroom
get
Get all mailroom statistics
get
Describe a mailroom
delete
Delete a mailroom
patch
Update a mailroom
get
Get single mailroom statistics
delete
Cancel mailroom
orgs/maintenanceWindow
4
get
Describe an organization's maintenance window
put
Create or update an organization's maintenance window
delete
Delete an organization's maintenance window
patch
Update an organization's maintenance window
orgs/maintenanceWindowDefinition
4
get
List all maintenance windows
post
Create a maintenance window for an organization
get
Describe a maintenance window
delete
Delete an organization's maintenance window
orgs/maintenanceWindowMap
3
get
List all maintenance windows maps
post
Create/Update/Delete maintenance window maps for an organization
get
Describe a maintenance window
orgs/mobileAppConfig
3
get
Get mobile app config
delete
Delete mobile app config
patch
Update mobile app config
orgs/namespaces
1
get
List all namespaces for the org (including IDP namespaces associated with the org)
orgs/opvideo-devices
2
post
Set/update the background image for an opvideo device facade
delete
Delete a background image for an opvideo device facade
orgs/orgIdentities
1
get
List all identity providers
orgs/orgPackagePlans
2
get
List all selected package plans
post
Request a package plan upgrade
orgs/orgPictures
5
get
List all org pictures
post
Create an org picture
get
Describe an org picture
delete
Delete an org picture
patch
Update an org picture
orgs/packagePlans
2
get
List all available package plans
get
Describe a package plan
orgs/palettes
2
get
List all palettes
get
Describe a palette
orgs/parcelMessageTypes
1
get
List all parcel message types
orgs/parcels
20
get
List active parcels
post
Create a parcel
delete
Delete multiple parcels
patch
Bulk update parcels
get
Describe a parcel
delete
Delete a parcel
patch
Update a parcel
get
Lists activity for parcels
get
Self-pickup - List parcels
get
Lists parcel history
get
List parcel pictures
post
Create a parcel picture
get
Get a parcel picture
delete
Delete a parcel picture
patch
Update a parcel picture
post
Send custom email to recipients
post
Self-pickup - resend parcel reminder
patch
Self-pickup - Update parcel status
get
Get a parcel signature
post
Sign parcels
orgs/parcelStatuses
1
get
List all parcel statuses
orgs/readers
7
get
List all owned or assigned readers
post
Create a reader
get
Describe an owned or assigned reader
delete
Delete a reader
patch
Update a reader
post
Remotely trigger a reader to restart
post
Remotely trigger a reader to identify itself via LED and buzzer
orgs/recentAlarms
1
get
List all recent alarms
orgs/recentAlarmsExt
1
get
Describe a recent alarm
orgs/relayHardwareTypes
2
get
List all relay hardware types
get
Describe a relay hardware type
orgs/relays
3
get
List all relays
get
Describe a relay
patch
Update a relay
orgs/reports
6
get
Get the search and display unix timestamp ranges for relative times based on the device with a timezone in the min utc offset
get
Get entry access activity
get
Search/filter/return audit logs for UI
get
Get presence bucket reports
get
Get access activity events
get
Get alarm events
orgs/rexs
3
get
List all REXs
get
Describe a REX
patch
Update a REX
orgs/roles
13
get
List all roles
post
Create a role
get
Describe a role
delete
Delete a role
patch
Update a role
get
List all users of a role
get
List all scope ids of a role
put
Set a role's scopes by replacing the entire set with this one
put
Set a role's users by replacing the entire set with this one
patch
Bulk-update a role's users
put
Add a user to a role
delete
Remove a user from a role
put
Set a role's sites by replacing the entire set with this one
orgs/schedules
12
get
List all schedules
post
Create a schedule
get
Describe a schedule
delete
Delete a schedule
patch
Update a schedule
get
Determine whether the API caller has access to modify this schedule via their admin permissions
get
List all schedule events
post
Create a schedule event
patch
Bulk update schedule events
get
Describe a schedule event
delete
Delete a schedule event
patch
Update a schedule event
orgs/scheduleTypes
2
get
List all schedule types
get
Describe a schedule type
orgs/scopeResources
2
get
List all scope resources
get
Describe a scope resource
orgs/sharedUsers
3
get
List all users that have access to at least one zone from this org (including users from other orgs via zone sharing)
get
Describe a user that has access to at least one zone from this org (including users from other orgs via zone sharing)
post
List all users that have access to at least one zone from this org (including users from other orgs via zone sharing)
orgs/sites
22
get
List all sites
post
Create a site
get
Describe a site
delete
Delete a site
patch
Update a site
get
List all users of a site
get
List location measurements for a site
get
Get location restriction for a site
put
Set location restriction for a site
delete
Delete location restriction for a site
get
Describe a location measurement for a site
delete
Delete a location measurement for a site
put
Set a site's users by replacing the entire set with this one
patch
Bulk-update a site's users
put
Add a user to a site
delete
Remove a user from a site
put
Set a location measurement for a site
get
List all groups of a site
put
Add a group to a site
delete
Remove a group from a site
put
Set a site's groups by replacing the entire set with this one
patch
Bulk-update a site's groups
orgs/subscriptions
5
get
List all REST Hook subscriptions
post
Create a REST Hook subscription
get
Describe a REST Hook subscription
delete
Delete a REST Hook subscription
patch
Update a REST Hook subscription
orgs/tasks
10
get
List all report tasks
post
Create a new batch report task.
get
Get a specific report task by id.
delete
Delete a specific report task by id.
get
List all schedules for all the report tasks
post
Create a new scheduled report task.
get
Get a specific task report schedule by id.
delete
Delete a specific task report schedule by id.
patch
Update a specific task report schedule
get
Get a link to the specific report task result by id.
orgs/termsAgreements
4
get
List all signed Terms of Service agreements
post
Create a signed Terms of Service agreement - DEPRECATED use /orgs/{orgId}/termsAgreements/sign instead
post
Check if org has signed an acceptable Terms Agreement for an app or application
post
Sign an acceptable Terms Agreement for an app or application
orgs/thirdPartyReaders
3
get
List all third party OSDP readers
get
Describe a third party OSDP reader
patch
Update a third party OSDP reader
orgs/thirdPartyWiegands
3
get
List all third party wiegand readers
get
Describe a third party wiegand reader
patch
Update a third party wiegand reader
orgs/triggerMethods
2
get
List all trigger methods
get
Describe a trigger method
orgs/triggerPermissionsChange
1
post
Trigger immediate entry permission recalculation & broadcast
orgs/unusedInputs
3
get
List all unused inputs
get
Describe an unused input
patch
Update an unused input
orgs/users
60
get
List all users
post
Create a user
get
Describe a user
delete
Delete a user
patch
Update a user
get
Describe user badge
get
List all zones a user has access to
get
List all ACUs a user has access to
get
List all sites of a user
get
List all roles of a user
get
Get a user's preference set
patch
Update a user's preference set
get
List all MFA credentials (for users in the local org namespace only)
get
List all user pictures
post
Create a user picture (DEPRECATED)
get
List all groups of a user
get
List all entries a user has access to
get
List all zones (and their associated configurations) a user has access to
put
Set a user's zones (and their associated configurations) by replacing the entire set with this one
patch
Bulk-update a user's zones and their associated configurations
get
List all user credentials
post
Create a user credential
get
List all user custom fields
patch
Update all user custom fields
get
Get a user's intercom notification preferences
patch
Update a user's intercom notification preferences
get
Describe a user custom field
patch
Update a user custom field
get
Describe a user credential
delete
Delete a user credential
patch
Update a user credential
get
Get a user's entry activity
get
Describe a user picture (DEPRECATED)
delete
Delete a user picture (DEPRECATED)
patch
Update a user picture (DEPRECATED)
get
List all no tour credential sector validation data for this user
post
Send email to user to verify email
post
List all users
post
Receives feedback from the user and store it
post
Use a cloudKey credential to request triggering a lockdown plan
post
Use a cloudKey credential to request a cloud-unlock of an entry
post
Generate new setup mobile token for credential
post
Send email to user to set up their mobile credential
post
Generate new cloudKey unlock token for a specific entry.
post
Generate new cloudKey token for a specific action on a specific lockdown plan
post
Use a cloudKey credential to request reverting a lockdown plan
post
Generate new cloudKey unlock token for a specific entry
put
Set a user's groups by replacing the entire set with this one
patch
Bulk-update a user's groups
put
Set a user's sites by replacing the entire set with this one
patch
Bulk-update a user's sites
put
Set a user's status
put
Set a user's zones by replacing the entire set with this one
put
Set a user's roles by replacing the entire set with this one
post
Send email to user to set up their wallet credential
post
Sync Apple Wallet Device
patch
Update Apple Wallet Device
get
Get the user avatar picture
put
Set the user avatar picture
delete
Delete the user avatar picture
orgs/videoProviderTypes
1
get
List all video provider types
orgs/widgetTypes
2
get
List all widget types
get
Describe a widget type
orgs/wiegands
3
get
List all wiegands
get
Describe a wiegand
patch
Update a wiegand
orgs/wirelessGateways
8
get
List all wireless gateways
post
Create a wireless gateway
get
Describe a wireless gateway
delete
Remove a wireless gateway
patch
Update a wireless gateway
post
Update the firmware for multiple wireless gateways to the latest version
post
Sync devices for a wireless gateway
post
Update the firmware for a wireless gateway to a specific version
orgs/wirelessLockGateways
8
get
List all wireless lock gateways
post
Create a wirelessLock gateway
get
Describe a wireless lock gateway
delete
Remove a wireless lock gateway
patch
Update a wirelessLock gateway
post
Update the firmware for multiple wireless lock gateways to the latest version
post
Sync devices for a wireless lock gateway
post
Update the firmware for a wireless lock gateway to a specific version
orgs/wirelessLockProviders
8
get
List all wireless lock providers
post
Create a wireless lock provider
get
Describe a wireless lock provider
delete
Remove a wireless lock provider and all related devices
get
List all operators for a wireless lock provider
get
List all firmwares available for a wireless lock provider by device
post
Invite self to be a site operator for a wireless lock provider
post
Sync devices for a wireless lock provider
orgs/wirelessLockReaders
5
get
List all wireless lock readers
post
Create a wirelessLock reader
get
Describe a wireless lock reader
delete
Remove a wireless lock reader
patch
Update a wirelessLock reader
orgs/wirelessLocks
8
get
List all wireless locks
post
Create a wireless lock
get
Describe a wireless lock
delete
Remove a wireless lock
patch
Update a wireless lock
post
Update the firmware for multiple wireless locks to the latest version
post
Update the firmware for a wireless lock to a specific version
post
Blink the reader or inside-push-button LED for a wireless lock to identify it.
orgs/wirelessLockTemplates
5
get
List all wireless lock templates
post
Create a wireless lock template
get
Get a wireless lock template
delete
Delete a wireless lock template
patch
Update a wireless lock template
orgs/zones
31
get
List all owned or shared zones
post
Create a zone
get
Describe an owned or shared zone
delete
Delete a zone
patch
Update a zone
get
List all zone anti-passback areas
post
Create a zone anti-passback area
get
List all groups of a zone
get
List all group IDs of a zone
put
Set a zone's groups by replacing the entire set with this one
get
List all users of a zone
get
List all shares of this zone
get
List all users (and their associated configurations) of a zone
put
Set a zone's users (and their associated configurations) by replacing the entire set with this one
patch
Bulk-update a zone's users (and their associated configurations)
get
List all groups (and their associated configurations) of a zone
put
Set a zone's groups (and their associated configurations) by replacing the entire set with this one
patch
Bulk-update a zone's groups (and their associated configurations)
get
Describe a zone anti-passback area
delete
Delete a zone anti-passback area
patch
Update a zone anti-passback area
post
Reset anti-passback for a zone and/or user
post
Relinquish shared zone from shared-to org
post
Share zone
post
Unshare zone
put
Add a group to a zone
delete
Remove a group from a zone
put
Add a user to a zone
delete
Remove a user from a zone
put
Set a zone's users by replacing the entire set with this one
put
Set this zone's shares by replacing the entire set with this one
tokens
2
post
Use a cloudKey token to remotely trigger or revert a lockdown plan
post
Use a cloudKey token to remotely unlock an entry
auth
Describe an access token's associated identity and scopes
Endpoint name
: describeAccessToken
get
/auth/accessTokens/{token}
Path parameters
token
string
required
Response
Successful
object
required
data
object
meta
object
Changes