API REFERENCE · SCHEMA

CounterpartyPage schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

itemsRequired
Counterparty[]
items item fields

Each array item: Counterparty.

items[].idRequired
string

Format: uuid.

items[].environmentRequired
string

Values: "sandbox", "production".

items[].labelRequired
string
items[].externalIdRequired
string or null

May be null.

items[].externalId fields and rules

Allowed alternatives

  • string
  • null

    May be null.

items[].relationshipRequired
string

Values: "customer", "vendor", "employee", "other".

items[].subjectRequired
objectView Subject schema
items[].subject fields and rules

See all Subject fields for the complete structure, required properties and constraints.

items[].tagsRequired
string[]
items[].tags item fields

Each array item: string.

items[].statusRequired
string

Values: "active", "archived".

items[].revisionRequired
integer

Minimum: 0.

items[].createdAtRequired
string

Format: date-time.

items[].updatedAtRequired
string

Format: date-time.

nextCursorRequired
string or null

May be null.

nextCursor fields and rules

Allowed alternatives

  • string
  • null

    May be null.

Use CounterpartyPage in a workflow

Used by

Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.

Implementation guides