Get allowed next status transitions for a referral

Error

A valid request URL is required to generate request examples

{
  "data": {
    "currentStatus": "signed",
    "availableTransitions": [
      {
        "status": "<string>",
        "label": "<string>",
        "requiresReason": true,
        "requiresClosingStatus": true
      }
    ]
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

GET

referrals

{id}

available-statuses

Error

A valid request URL is required to generate request examples

{
  "data": {
    "currentStatus": "signed",
    "availableTransitions": [
      {
        "status": "<string>",
        "label": "<string>",
        "requiresReason": true,
        "requiresClosingStatus": true
      }
    ]
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-Key

string

header

required

Public API key (format cxp_<tier>_<body>, tier = ro|std|full). Scoped to a single firm. The firm must have public_api in allowedIntegrations.

Path Parameters

string<uuid>

required

Referral UUID

Response

Available status transitions

data

object

required

Show child attributes