Skip to main content
GET
GET Custom Term Definition

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
customTermId
string
required

Response

OK

id
string
read-only

Prophia internal Custom Term Definition ID (UUID).

accountId
string
read-only

The UUID for the Account this Custom Term Definition is associated with.

tagName
string
read-only

Human-readable name of the custom term; appears as tagName on concrete Tags created from this definition.

definitionType
enum<string>
read-only

Value type the term captures; MULTI is multiple choice. Date terms, when captured as concrete Tags, are available in Prophia's critical date notification framework.

Available options:
CURRENCY,
TEXT,
MULTI,
DATE
description
string

Human-readable description of the term.

definition
string

Instructions that tell Prophia's AI extraction what to capture. Together with examples, keywords, and multipleChoiceOptions this forms the term's extraction blueprint.

examples
string[]

Example phrasings that help the AI extraction recognize the term.

keywords
string[]

Keywords that help locate the term in documents during AI extraction.

multipleChoiceOptions
string[]

Allowed values, when the definitionType is MULTI (multiple-choice).

aiEnabled
boolean

Whether Prophia's AI extraction attempts to capture this term automatically when a new Document is created in the system.

createdBy
string
read-only

The user who created the definition.

createdAt
string<date-time>
read-only

When the definition was created.

updatedAt
string<date-time>
read-only

When the definition was last modified.

numberOfUses
integer<int64>
read-only

Number of concrete Tags in the account that reference this Custom Term Definition.