Skip to main content
GET
/
v1
/
crm
/
leads
/
{leadId}
/
principals
List Lead Principals
curl --request GET \
  --url https://api.example.com/v1/crm/leads/{leadId}/principals \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "totalCount": 123,
    "totalPages": 123,
    "page": 123,
    "perPage": 123
  },
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "leadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "role": "<string>",
      "percentOwnership": 123,
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "phoneNumber": "<string>",
      "dob": "<string>",
      "ssn": "<string>",
      "addressLabel": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "zip": "<string>",
      "bankruptcy": true,
      "isManagingDirector": true,
      "identificationId": "<string>",
      "identificationIssuedAt": "<string>",
      "identificationExpiresAt": "<string>",
      "identificationIssuingState": "<string>",
      "identificationIssuingCountry": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Enter token in following format: Bearer

Path Parameters

leadId
string
required

Query Parameters

q
string
size
number
default:20
page
number
default:1
sort
string
default:-createdAt
filter
object
expand
searchable
string[]
before
object
after
object

Response

The paginated list of lead principals.

meta
object
required
data
object[]
required