Skip to main content
GET
List AD plans in the org

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "building": Include the anchoring building (id, ref, name).
  • "document": Include the background document (id, ref, name, mimeType, size, downloadUrl) when present.
  • "actions-info": Adds actions { canBeUpdated, canBeDeleted, canReplaceDocument, canBeCalibrated } per row.
  • "updatable-fields": Adds updatableFields (per-field editability) per row.
Available options:
building,
document,
actions-info,
updatable-fields
orderBy
object[]
whereName
string

Filter by plan name (contains, case-insensitive).

Maximum string length: 200
Example:

"lobby"

whereBuildingId
string<uuid>

Filter by the anchoring building id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
whereCreatedAt
object

Filter by the creation-date range.

Example:

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required