Filter segments

POST

/segments/filter-segments

Search and list segments for the workspace.

Request body fields (from the product UI / controller):

conditions — array of { field, operator, value } applied to segment columns
(e.g. name, folderIds, searchTokens, __name__, isDefault). Not contact filters.

limit — page size

paginationToken — opaque cursor from a previous response meta

orderBy — defaults to createdAt (UI often uses updatedAt)

orderType — defaults to desc

Response is JSON:API-style { data, meta } using the list serializer
(id, name, description, segmentSources, conditions, folderIds, config, timestamps, isDefault).

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Body Params application/json

Examples

Responses

🟢200

application/json

Filtered segments

Bodyapplication/json

🟠401

Request Example

Shell

JavaScript

Java

Swift

cURL

List recent segments (product list page)Segments in a folderSegments with no folder (empty folderIds)Token search (segment list search box)Fetch specific segments by id

curl --location 'https://app.highperformr.ai/api/segments/filter-segments' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "limit": 25,
    "orderBy": "updatedAt",
    "orderType": "desc"
}'

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"
                ],
                "folderIds": [
                    "folder_abc123"
                ],
                "conditions": [],
                "isDefault": false,
                "createdAt": "2025-04-08T09:01:44.000Z",
                "updatedAt": "2025-04-10T12:00:00.000Z"
            }
        }
    ],
    "meta": {
        "nextToken": "eyJwYWdlIjoyfQ"
    }
}

Modified at 2026-09-24 07:44:15

Clone segment

Bulk upsert sources