Skip to main content
GET
/
received-referrals
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "referenceNumber": "<string>",
      "cmsId": "<string>",
      "sendingFirmName": "<string>",
      "sendingFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "draft",
      "closingStatus": "won_settled",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-Key
string
header
required

Public API key (starts with cxp_). Required on every request.

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100
status
enum<string>
Available options:
draft,
sent,
under_evaluation,
investigating,
signed,
in_litigation,
closing,
rejected,
withdrawn,
closed

Search by reference number or sending firm name

sort
enum<string>

Sort field: updatedAt (default), status, referenceNumber

Available options:
updatedAt,
status,
referenceNumber
order
enum<string>
default:desc
Available options:
asc,
desc

Response

Paginated list of received referrals

data
object[]
pagination
object
meta
object