Openpath orgs/acuPorts API
The orgs/acuPorts API from Openpath — 1 operation(s) for orgs/acuports.
OpenAPI Specification
swagger: '2.0'
info:
title: Openpath API Documentation auth orgs/acuPorts API
version: 1.0.0
description: Authentication and Login
host: api.openpath.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: orgs/acuPorts
paths:
/orgs/{orgId}/acuPorts:
get:
summary: List all ACU ports
operationId: listAllAcuPorts
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}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-outboundWebhooks:w,o{params.orgId}-outboundWebhooks:r,o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listAllAcuPorts'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
minimum: 1
maximum: 1000
name: limit
in: query
- type: integer
default: 0
minimum: 0
name: offset
in: query
- type: string
default: acu.id, expansionBoard.number, id
pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
name: sort
in: query
- type: string
default: asc, asc, asc
pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
name: order
in: query
- type: string
name: q
in: query
- type: string
name: filter
in: query
- type: string
name: preFilter
in: query
consumes:
- application/json
produces:
- application/json
tags:
- orgs/acuPorts
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
id:
type: number
acuPortTypePortNumber:
type: number
virtualPortNumber:
type: number
x-nullable: true
portNumber:
type: number
x-nullable: true
parentChainedAcuPort:
x-nullable: true
type: object
properties:
id:
type: number
required:
- id
childChainedAcuPorts:
type: array
items:
type: object
properties:
id:
type: number
required:
- id
acu:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
expansionBoard:
x-nullable: true
type: object
properties:
id:
type: number
number:
type: number
acuModel:
type: object
properties:
id:
type: number
name:
type: string
isBaseModel:
type: boolean
required:
- id
required:
- id
acuPortType:
type: object
properties:
id:
type: number
name:
type: string
ios:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
modelName:
type: string
isShadow:
type: boolean
primaryIoId:
type: integer
x-nullable: true
isEntryIo:
type: boolean
required:
- id
required:
- id
io:
type: object
properties:
id:
type: number
name:
type: string
modelName:
type: string
isShadow:
type: boolean
primaryIoId:
type: integer
x-nullable: true
isEntryIo:
type: boolean
required:
- id
modelId:
type: number
x-nullable: true
modelName:
type: string
label:
type: string
reader:
type: object
properties:
id:
type: number
name:
type: string
serialNumber:
type: string
x-nullable: true
serialNumberBrief:
type: string
x-nullable: true
firmwareVersion:
type: string
x-nullable: true
softwareVersionNumber:
type: string
x-nullable: true
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
x-nullable: true
nfcEnabled:
type: boolean
autoUnlockEnabled:
type: boolean
autoUnlockRssi:
type: integer
minimum: -95
maximum: -30
acuPort:
x-nullable: true
type: object
properties:
id:
type: number
acuPortTypePortNumber:
type: number
virtualPortNumber:
type: number
x-nullable: true
portNumber:
type: number
x-nullable: true
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:
x-nullable: true
type: object
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
x-nullable: true
allowedDistanceMeters:
type: number
scaleFactor:
type: number
required:
- id
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
notes:
type: string
x-nullable: true
isAudibleFeedbackEnabled:
type: boolean
isLedFeedbackEnabled:
type: boolean
pinTimeoutSeconds:
type: integer
isAppleWalletTraEnabled:
type: boolean
required:
- id
relay:
type: object
properties:
id:
type: number
name:
type: string
openDurationSeconds:
type: number
x-nullable: true
invertOutput:
type: boolean
relayHardwareType:
x-nullable: true
type: object
properties:
id:
type: number
name:
type: string
required:
- id
acuPort:
x-nullable: true
type: object
properties:
id:
type: number
acuPortTypePortNumber:
type: number
virtualPortNumber:
type: number
x-nullable: true
portNumber:
type: number
x-nullable: true
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
required:
- id
eol:
x-nullable: true
type: object
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
required:
- id
contactSensor:
type: object
properties:
id:
type: number
name:
type: string
isAjarEnabled:
type: boolean
ajarDurationSeconds:
type: number
x-nullable: true
isForcedOpenEnabled:
type: boolean
acuPort:
x-nullable: true
type: object
properties:
id:
type: number
acuPortTypePortNumber:
type: number
virtualPortNumber:
type: number
x-nullable: true
portNumber:
type: number
x-nullable: true
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
required:
- id
eol:
x-nullable: true
type: object
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
required:
- id
rex:
type: object
properties:
id:
type: number
name:
type: string
mode:
type: string
enum:
- 'NO'
- NC
isTriggerRelayEnabled:
type: boolean
bypassDurationSeconds:
type: integer
x-nullable: true
acuPort:
x-nullable: true
type: object
properties:
id:
type: number
acuPortTypePortNumber:
type: number
virtualPortNumber:
type: number
x-nullable: true
portNumber:
type: number
x-nullable: true
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
required:
- id
eol:
x-nullable: true
type: object
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
required:
- id
wiegand:
type: object
properties:
id:
type: number
name:
type: string
isExit:
type: boolean
mode:
type: string
enum:
- input
- output
isPassThroughEnabled:
type: boolean
defaultCardNumber:
type: string
x-nullable: true
defaultCardNumBits:
type: integer
x-nullable: true
acuPort:
x-nullable: true
type: object
properties:
id:
type: number
acuPortTypePortNumber:
type: number
virtualPortNumber:
type: number
x-nullable: true
portNumber:
type: number
x-nullable: true
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
required:
- id
eol:
x-nullable: true
type: object
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
required:
- id
readerShadow:
type: object
properties:
id:
type: number
readerId:
type: number
acuPort:
x-nullable: true
type: object
properties:
id:
type: number
acuPortTypePortNumber:
type: number
acu:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
expansionBoard:
type: object
properties:
id:
type: number
number:
type: integer
required:
- id
required:
- id
required:
- id
wiegandShadow:
type: object
properties:
id:
type: number
wiegandId:
type: number
acuPort:
x-nullable: true
type: object
properties:
id:
type: number
acuPortTypePortNumber:
type: number
acu:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
expansionBoard:
type: object
properties:
id:
type: number
number:
type: integer
required:
- id
required:
- id
required:
- id
thirdPartyReader:
type: object
properties:
id:
type: integer
name:
type: string
osdpAddress:
type: number
osdpBaudRate:
type: number
enum:
- 9600
- 19200
- 38400
- 57600
- 115200
- 230400
acuPort:
x-nullable: true
type: object
properties:
id:
type: integer
acuPortTypePortNumber:
type: number
virtualPortNumber:
type: number
x-nullable: true
portNumber:
type: number
x-nullable: true
parentChainedAcuPort:
x-nullable: true
type: object
properties:
id:
type: integer
required:
- id
childChainedAcuPorts:
type: array
items:
type: object
properties:
id:
type: integer
required:
- id
label:
type: string
acu:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
expansionBoard:
type: object
properties:
id:
type: integer
number:
type: integer
required:
- id
eol:
x-nullable: true
type: object
properties:
eolSupervision:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
required:
- id
- parentChainedAcuPort
- childChainedAcuPorts
entries:
type: array
items:
type: object
properties:
id:
type: integer
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-acuports-api-openapi.yml