Skip to main content
GET
LIST Raw Tag

Filters

Filters combine with AND: a result must match every filter you supply.

Authorizations

X-API-Key
string
header
required

Prophia API key — either an account key (grants admin level permissions) or a user key with the REST scope. Send it in the X-API-Key header, or equivalently as Authorization: Bearer <api-key>. JWTs are rejected on /rest endpoints with 401.

Path Parameters

accountId
string
required
leaseId
string
required

Query Parameters

include
enum<string>[]

Optional collections to populate. Unknown keys are rejected with 400.

  • tagSelections — adds the citation list (bounding boxes on doc pages).
  • pages — adds the per-page geometry for cited pages.
  • applicableSpaces — adds the suite/floor list this tag applies to.
Available options:
tagSelections,
pages,
applicableSpaces
page
integer<int32>
default:0

0-based page index. Negative values are clamped to 0.

limit
integer<int32>
default:50

Page size. Values outside 1–200 are clamped, not rejected; check the response's limit for the value actually applied.

sortBy
enum<string>
default:tagName

Sort field. Defaults to tagName; unrecognized values silently fall back to the default.

Available options:
tagName,
createdAt,
updatedAt
sortDir
string
default:asc

Sort direction: asc (default) or desc. Any other value is treated as asc.

Filter
tagName
string

Case-insensitive contains match on the tag name.

Filter
isCustomTag
boolean

Filters to custom tags (true) or standard-definition tags (false); omit for both.

Filter
lifecycleStatus
enum<string>

Exact match on the tag's lifecycle status.

Available options:
ACTIVE,
VOID,
STRICKEN,
EXERCISED
Filter
createdAtAfter
string<date-time>

Tags created at or after this timestamp; inclusive.

Filter
createdAtBefore
string<date-time>

Tags created at or before this timestamp; inclusive.

Response

OK

totalCount
integer<int64>

Total number of items matching the request across all pages.

page
integer<int32>

0-based index of this page.

limit
integer<int32>

Page size actually applied — requested values outside 1–200 are clamped.

items
object[]

The Tags on this page of results.

hasMore
boolean

True when more pages exist after this one. Iterate on this rather than computing page counts from totalCount, which can change between requests.