Skip to main content
GET
GET Raw Tag

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
tagId
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

Response

OK

Each Tag is a representation of a single data term (Square Footage, Suite Number, Base Rent Schedule, etc). Prophia's system consolidates iterations of a Tag through the timeline of the containing Lease, using other adjacent Tags in some cases, to build out rich representations of the data values in the Tag.

id
string
read-only

Prophia internal Tag ID (UUID).

tagName
string

Machine name of the term (e.g. rentSchedule, securityDeposit). Tag names may occasionally appear in the format optionName.componentTagName denoting that the component tag belongs to a family of tags associated with that option name (e.g. autoRenewal.autoRenewalRate).

displayName
string

Human-readable term name as shown in the Prophia app.

isCustomTag
boolean

True when this tag instantiates one of the account's custom term definitions.

category
enum<string>

STANDARD: a single captured value — the value and schedule fields are the most common places to find relevant data for standard type Tags. COMPLEX: an option or right — the tagComponents field will contain data related to the component family related to the parent option Tag. EXHIBIT: captured exhibit data.

Available options:
STANDARD,
COMPLEX,
EXHIBIT
value
date · object

The basic captured data for this Tag. Some tags may have additional customValues, tagComponents, or schedules that supplement this. Branch on value.kind for its shape: date, number, money, percent, and text carry a single value, while dateRange and numberRange carry start and end instead. Every kind also carries unit, capturedData, and ocrText, and the typed fields are omitted when capturedData could not be parsed into the kind's type — capturedData always holds the raw text. A numeric value captured with a percent unit arrives as percent — a pro-rata share (prs, opexPrs, taxPrs), a gross up, or a rent bump, for instance — carrying the percentage itself, so 3.5 means three and a half percent. Tags that accept both percent and dollar units, such as rentBump and opexCap, return percent or money according to the unit the value was captured with. A tag declared as a string type returns text even when a percent unit is present.

customValue1
string

Tag-specific extra field; meaning depends on the tag.

customValue2
string

Tag-specific extra field; meaning depends on the tag.

customValue3
string

Tag-specific extra field; meaning depends on the tag.

customValue4
string

Tag-specific extra field; meaning depends on the tag.

customValue5
string

Tag-specific extra field; meaning depends on the tag.

customValue6
string

Tag-specific extra field; meaning depends on the tag.

schedule
object

Series data for terms that carry one — rent steps, abatement periods, deposit burn-downs. Branch on schedule.kind.

tagComponents
AUTO_RENEWAL · object

Structured detail for COMPLEX tags (options and rights). Branch on its kind. Null for STANDARD tags.

amendingTag
object

Present when this tag amends/supersedes an earlier tag (its DB reference_id / OPTION option-group anchor). amendedTagId is the earlier (amended) tag's id; this is populated for any tag carrying a reference, not just OPTION/complex tags. For OPTION tags the same pointer is also mirrored inside tagComponents.amendingTag.

lifecycleStatus
enum<string>

State of this tag record across the lease's document history. Distinct from a component's rightStatus — the two are resolved independently and can disagree. Typically this lifecycle status refers to individual STANDARD tags or tagComponents.

Available options:
ACTIVE,
VOID,
STRICKEN,
EXERCISED
leaseId
string

Lease this tag belongs to.

leaseDocId
string

Document this tag was extracted from.

applicableSpaces
object[]

Spaces the term applies to; only populated when include=applicableSpaces is present in the request parameters. Entries reference building spaces by suite name, not by id.

createdAt
string<date-time>

When the tag was created.

updatedAt
string<date-time>

When the tag was last modified.

tagSelections
object[]

Citations: rectangles on document pages where the term was captured; only populated when include=tagSelections is present in the request parameters.

pages
object[]

Geometry of the cited pages, for placing tagSelections bounding boxes; only populated when include=pages is present in the request parameters.

url
string

Deep link to this tag in the Prophia web app.