GET/api/v1/contacts

Get all Contacts

Returns a list of contacts with pagination support.

Authentication

Send your API key in the x-api-key header.

x-api-keybearer

Parameters

page

query · number

Page number to retrieve.

limit

query · number

Number of items per page.

email

query · string

Contact email to filter contacts by (partial match).

name

query · string

Contact name to filter contacts by (partial match).

opportunityId

query · string

Opportunity ID to filter contacts by.

companyId

query · string

Company ID to filter contacts by.

Responses

200

PublicApiGetContactsResponseDto

statusCoderequired

number

countrequired

number

errorrequired

string

datarequired

array<PublicApiContactDto>

Example response

json

{
  "statusCode": 200,
  "count": 0,
  "error": null,
  "data": [
    {
      "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "firstName": "John",
      "lastName": "Doe",
      "salutation": "Mr.",
      "birthday": "1990-01-15T00:00:00.000Z",
      "email": "john.doe@example.com",
      "phone": "+1-555-123-4567",
      "genderIdentity": "Male",
      "pronouns": "he/him",
      "fax": "+1-555-123-4568",
      "linkedinUrl": "https://linkedin.com/in/johndoe",
      "address": "123 Main Street",
      "postalCode": "12345",
      "city": "New York",
      "state": "NY",
      "country": "United States",
      "currency": "USD",
      "titlePosition": "Software Engineer",
      "language": "English",
      "assistant": "Jane Smith",
      "assistantPhone": "+1-555-123-4569",
      "division": "Engineering",
      "department": "Software Development",
      "description": "Senior software engineer with 5 years of experience",
      "leadSource": "Website",
      "leadRecordType": "Lead",
      "reportsTo": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z",
      "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
    }
  ]
}

401Unauthorized - missing or invalid API key or Bearer token