Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
acs_credential_id
string<uuid>

ID of the credential for which you want to retrieve all entrances.

acs_entrance_ids
string<uuid>[]

IDs of the entrances for which you want to retrieve all entrances.

acs_system_id
string<uuid>

ID of the access system for which you want to retrieve all entrances.

connected_account_id
string<uuid>

ID of the connected account for which you want to retrieve all entrances.

customer_key
string

Customer key for which you want to list entrances.

limit
integer
default:900

Maximum number of records to return per page.

Required range: x > 0
location_id
string<uuid> | null
deprecated

Deprecated. Use space_id.

page_cursor
string | null

Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

String for which to search. Filters returned entrances to include all records that satisfy a partial match using display_name.

Minimum string length: 1
space_id
string<uuid>

ID of the space for which you want to list entrances.

Response

OK

acs_entrances
object[]
required
pagination
object
required

Information about the current page of results.