Skip to main content
GET
/
v1
/
contacts
List contacts
curl --request GET \
  --url https://api.slant.app/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "abc123xyz",
      "book_id": "book123xyz",
      "person": {
        "id": "abc123xyz",
        "book_id": "book123xyz",
        "first_name": "John",
        "last_name": "Doe",
        "household_id": "xyz789abc",
        "contact_id": "cnt456def",
        "role_type": "client",
        "middle_name": "Robert",
        "salutation": "Mr.",
        "suffix": "Jr.",
        "maiden_name": "Smith",
        "gender": "male",
        "designations": "CPA, CFP",
        "household_role": "head_of_household",
        "preferred_name": "Johnny",
        "date_of_birth": "1985-06-15",
        "job_title": "Software Engineer",
        "ssn": "***-**-6789",
        "drivers_license_number": "******7890",
        "email_addresses": [
          {
            "email": "john.doe@example.com",
            "email_type": "personal",
            "is_primary": true
          }
        ],
        "phone_numbers": [
          {
            "phone_number": "+15555551234",
            "phone_type": "mobile",
            "is_primary": true
          }
        ],
        "addresses": [
          {
            "address_type": "home",
            "is_primary": true,
            "line1": "123 Main St",
            "line2": "Apt 4B",
            "city": "New York",
            "state": "NY",
            "zip": "10001",
            "country_code": "US"
          }
        ],
        "employments": [
          {
            "business_name": "Acme Corp",
            "id": "emp123xyz",
            "person_id": "abc123xyz",
            "role": "Software Engineer",
            "start_date": "2023-01-15",
            "end_date": "2024-12-31",
            "actively_employed": true
          }
        ],
        "custom_fields": {
          "preferred_contact_method": "Email",
          "risk_tolerance": "Moderate"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Query Parameters

page
integer

Page number

per_page
integer

Items per page (1-100, default: 25). Values over 100 will be clamped to 100.

Required range: 1 <= x <= 100
book_id
string

Filter by book ID

email
string

Filter by exact email match

phone
string

Filter by exact phone match (E.164 format)

name
string

Filter by person name (prefix match)

Response

successful

data
object[]
required
pagination
object
required