Get segment by ID

GET

/segments/{id}

Returns one segment by id (full segment serializer).

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Responses

🟢200

application/json

Segment details

Bodyapplication/json

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Success

{
    "data": {
        "id": "seg_4n2k8j",
        "type": "segments",
        "attributes": {
            "name": "Enterprise prospects",
            "description": "Inbound engagers from LinkedIn social listening",
            "segmentSources": [
                "src_li_inbound_01",
                "src_li_post_01"
            ],
            "folderIds": [
                "folder_abc123"
            ],
            "conditions": [],
            "isDefault": false,
            "refreshStatus": "completed"
        }
    }
}

Modified at 2026-08-06 14:14:15

Create segment

Update segment