Get contact schema

GET

/schema/contact

Returns the field definitions for contacts (and related company fields) in this workspace. Each item includes a writeAccessPath—use that exact string when:

building filter conditions (field on POST /contacts/filter-contacts and related APIs),

choosing which attributes to return (fields on filter and POST /contacts/by-segment/{segmentId}).

Paths look like contact.<name>, company.<name>, or contact.customFields.<id> for custom fields. There is no fixed enum of paths; always read them from this response for your account.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Responses

🟢200

application/json

Field metadata including writeAccessPath, types, and labels. Use writeAccessPath values in filter and segment contact APIs.

Bodyapplication/json

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://app.highperformr.ai/api/schema/contact' \
--header 'x-api-key: <api-key>'

Response Example

200 - Success

{
    "status": "ok",
    "message": "Success"
}

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

Unified Data API - async contact enrichment

Get discovery search contact schema