ghl_contact_lookup
Look up contacts by exact email or phone within a location, including additional emails and phone numbers, with pagination for paging through matching results.
Instructions
Lookup Contact By Email Or Phone
Look up contacts matching an exact email or phone, scoped to a location, up to limit contacts (max 20) per page. Also matches against a contact's additional emails and additional phone numbers. Exactly one of email or phone must be provided. Paginate with nextCursor. Returns an empty contacts array if no contact matches. OAuth channel only.
Endpoint: GET /contacts/lookup (Version header: v3; source: v3/contacts-v3.json)
OAuth scopes: contacts.readonly
Pagination params: limit — pass them to page through full result sets.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Exact email to look up (case-insensitive), mutually exclusive with `phone`. | ||
| limit | No | Max number of contacts to return per page. Defaults to 20, capped at 20. | |
| phone | No | Exact phone number to look up, in E.164 format, mutually exclusive with `email`. | |
| locationId | Yes | Location Id. Must be a non-empty string. | |
| nextCursor | No | Opaque pagination cursor returned as `nextCursor` by a previous request. |