Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Contacts

List all contacts

<small>Requires the contacts:read scope (or a broader one that includes it).</small>

Use this endpoint when you need to browse your contacts or look one up by its email or LinkedIn URL. Results are returned as a page controlled by the top and skip query parameters; omit both to get the first page. Pass email and/or linkedIn to narrow the results to contacts matching those exact identifiers. For richer, rule-based filtering use the filter endpoint instead.

get/v3/contacts

Query parameters

topinteger

Maximum number of contacts to return (default 25, max 1000)

skipinteger

Number of contacts to skip

emailstring

Filter contacts by email address

linkedInstring

Filter contacts by LinkedIn profile URL

Response

List of contacts retrieved successfully

hasMoreboolean

Indicates if there are more items to fetch

Example response

{
  "items": [
    {
      "id": 12345,
      "email": "john.doe@company.com",
      "firstName": "John",
      "lastName": "Doe",
      "title": "Senior Product Manager",
      "company": "Tech Solutions Inc",
      "domain": "company.com",
      "companySize": "oneThousand",
      "city": "San Francisco",
      "state": "CA",
      "country": "United States",
      "timeZoneId": "America/Los_Angeles",
      "phone": "+1-415-555-0123",
      "phoneStatus": "valid",
      "linkedInUrl": "https://www.linkedin.com/in/johndoe",
      "linkedInSalesNavigatorUrl": "https://www.linkedin.com/sales/profile/123456",
      "linkedInRecruiterUrl": "https://www.linkedin.com/recruiter/profile/789012",
      "industry": "Software & Technology",
      "notes": "Met at SaaS Conference 2024",
      "ownerUserId": 42,
      "accountId": 100,
      "isOptedOut": false,
      "callStatus": "toCall",
      "meetingStatus": "none",
      "addingDate": "2024-03-08T10:00:00+00:00",
      "createdAt": "2024-03-08T10:00:00",
      "lastModifiedAt": "2024-03-10T15:30:00",
      "customFields": [
        {
          "key": "leadSource",
          "value": "Conference"
        },
        {
          "key": "budget",
          "value": "100k-250k"
        }
      ]
    }
  ]
}