Skip to main content
GET
Look up a link by external ID

Authorizations

X-API-Key
string
header
required

Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.

Query Parameters

system
enum<string>
required
Available options:
cloudlex,
morgan_morgan,
litify
externalId
string
required

Record identifier in the external system

Required string length: 1 - 255

Response

Link with referral summary

id
string<uuid>
required
referralId
string<uuid>
required
externalSystem
enum<string>
required
Available options:
cloudlex,
morgan_morgan,
litify
externalId
string
required
Maximum string length: 255
externalUrl
string<uri> | null
required
createdAt
string<date-time>
required
referral
object
required
meta
object
required