Get contacts by segment

POST

/contacts/by-segment/{segmentId}

Returns contacts that belong to the given segment. Optionally add conditions to narrow results further; condition rules are the same as POST /contacts/filter-contacts.

You must send fields: a non-empty array of writeAccessPath strings from GET /schema/contact describing which columns to return per contact.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Contacts in segment

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://app.highperformr.ai/api/contacts/by-segment/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "fields": [
        "contact.firstName",
        "contact.lastName",
        "contact.workEmail",
        "company.companyName"
    ],
    "conditions": [
        {
            "field": "contact.jobTitle",
            "operator": "LIKE",
            "value": "Director"
        }
    ],
    "limit": 50
}'

Response Example

200 - Success

{
    "data": [
        {
            "id": "cnt_7f3k9m2pqx",
            "firstName": "Jamie",
            "lastName": "Rivera",
            "fullName": "Jamie Rivera",
            "title": "Staff Software Engineer",
            "linkedIn": "https://www.linkedin.com/in/jamie-rivera-example",
            "emails": [
                "jamie.rivera@acme.io"
            ],
            "sources": [
                "src_csv_import_2025_01"
            ],
            "companies": [
                "cmp_4n8k2j1w"
            ],
            "primaryCompanyId": "cmp_4n8k2j1w",
            "company": {
                "id": "cmp_4n8k2j1w",
                "companyName": "Acme Analytics Inc",
                "companyWebsite": "https://www.acme.io",
                "companyIndustry": "Computer Software",
                "companyHeadcount": "201-500"
            },
            "createdAt": "2025-03-12T14:22:11.000Z",
            "updatedAt": "2025-04-08T09:01:44.000Z"
        }
    ],
    "meta": {
        "totalRecords": 12840,
        "previousToken": "eyJvIjoxfQ",
        "nextToken": "eyJvIjoyfQ"
    }
}

Modified at 2026-04-22 07:54:17

Bulk fetch contacts by IDs

Get contact by ID