Operation

GET /contacts

Searchkick-backed contact search over the HiEnergy contact graph. Available to any authenticated API user. Results are always limited to HiEnergy-publisher contacts with rating ≥ 1. By default status `unverified` is excluded; pass `include_unverified=true` to include those contacts (the rating filter still applies). Filters support advertiser id/slug/name, email, domain, free-form `q`, exact `source` or multi-value `sources` (comma-separated or repeated query params), `has_linkedin=true` to require a LinkedIn profile URL, and `include_unverified=true`. MCP clients may pass aliases such as `query`/`search`/`keyword`, `url`/`website`, and `advertiser`/`merchant`/`brand`/`company`; the MCP layer normalizes those aliases before calling this endpoint. Raw REST accepts only the documented parameter names.

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 domain or URL (normalized)
advertiser_id query No string Advertiser slug or numeric id
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
include_unverified query No boolean When true, include contacts with status unverified. Does not relax the rating ≥ 1 filter.
page query No integer
per_page query No integer
limit query No integer

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 HiEnergy contacts GET /api/v1/contacts OpenAPI operationId: listContacts.
GET /api/v1/contacts OpenAPI

Search HiEnergy contacts


    
Ask Dex AIIntegration help

If this page feels TLDR, ask Dex AI.

Dex AI speaks your language, and all the other languages you may not. It will write the integration for you with the right endpoint and headers in one plain-English answer.