Skip to main content
GET
/
external-links
/
list
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalSystem": "<string>",
      "externalId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "referral": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "currentStatus": "<string>",
        "validNextStatuses": [
          "<string>"
        ],
        "canBeginClosing": true,
        "canClose": true,
        "referenceNumber": "<string>",
        "settlementAmount": 123,
        "clientFeeAgreementPercentage": 123,
        "attorneyFees": 123,
        "closingStatus": "<string>"
      },
      "externalUrl": "<string>"
    }
  ],
  "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 (format cxp_<tier>_<body>, tier = ro|std|full). Scoped to a single firm. The firm must have public_api in allowedIntegrations.

Query Parameters

system
enum<string>
required

External system filter

Available options:
cloudlex,
morgan_morgan
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
limit
integer
default:20

Results per page

Required range: 1 <= x <= 100

Response

Paginated list of external links

data
object[]
required
pagination
object
required
meta
object
required