Search contacts in the caller's scope
GET /contacts
GET /contacts
Operation
GET
/contacts
Searchkick-backed contact search over the HiEnergy contact graph. Non-admin callers only see contacts visible through their advertiser scope; admins see everything. Filters support advertiser id/slug/name, email, domain, free-form `q`, exact `source` or multi-value `sources` (comma-separated or repeated query params), and `has_linkedin=true` to require a LinkedIn profile URL.
Operation ID:
listContacts
·
Tags: Contacts
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
q
|
query | No | string | Free-form query (name, email, company) |
domain
|
query | No | string | — |
advertiser_id
|
query | No | string | — |
advertiser_name
|
query | No | string | — |
email
|
query | No | string | — |
source
|
query | No | string | Exact match on contacts.source |
sources
|
query | No | string | Comma-separated list of exact source values (OR) |
has_linkedin
|
query | No | boolean | When true, only contacts with linkedin_profile_url set |
page
|
query | No | integer | — |
per_page
|
query | No | integer | — |
limit
|
query | No | integer | — |
dry_run
|
query | No | boolean | — |
Request Body
No request body is defined for this operation.
Responses
Content Types
application/json
{
"description": "Contacts list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
},
"meta": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"data",
"meta"
]
}
}
}
}{
"$ref": "#/components/responses/Unauthorized"
}{
"$ref": "#/components/responses/Forbidden"
}API Playground
Run this GET request with your API key, or open it in a new tab. Path uses sample IDs where the OpenAPI path has {parameters}.
Sign in to enable live testing with your API key.
| Action | Method | Endpoint | Description |
|---|---|---|---|
| Search contacts in the caller's scope | GET |
/api/v1/contacts |
OpenAPI operationId: listContacts. |
GET /api/v1/contacts
OpenAPI
Search contacts in the caller's scope