Skip to main content
GET
Get relationship type

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Path Parameters

relationshipTypeId
string
required

The relationship type id.

Minimum string length: 1

Response

Success

kind
string
required
Allowed value: "person_to_co"
customObjectType
string
required
relationshipTypeId
string
required
role
string
required

Edge role, e.g. "placed" or "has_line_item".

cardinality
enum<string> | null
required
Available options:
ONE_TO_ONE,
ONE_TO_MANY,
MANY_TO_ONE,
MANY_TO_MANY
description
string | null
required
bidirectional
boolean
required