List Segments

Workspace-scoped paginated list. Supports targetType / folderId / status / search and the same JSON filter expression contacts list accepts. Pass `folderId='unfiled'` to scope to segments that have no folder set.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Query Parameters

pageNumberinteger

Default: 0Minimum: 0Maximum: 9007199254740991

pageSizeinteger

Default: 20Minimum: 1Maximum: 200

sortFieldstring

sortDirectionstring

Value in: "asc" | "desc"

searchstring

targetTypestring

Value in: "contact" | "order" | "ticket"

folderIdAny properties in string,string

statusstring

Value in: "active" | "archived"

filtersstring

GET/v1/segments/

curl -X GET "https://api.3common.com/v1/segments/?sortField=name&sortDirection=asc&search=string&targetType=contact&folderId=string&status=active&filters=string" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": [
    {
      "id": "string",
      "ownerId": "string",
      "name": "string",
      "description": "string",
      "targetType": "contact",
      "kind": "active",
      "filters": [
        {
          "logic": "and",
          "conditions": [
            null
          ],
          "property1": null,
          "property2": null
        }
      ],
      "formId": "string",
      "folderId": "string",
      "status": "active",
      "trackMembershipEvents": true,
      "refreshIntervalMs": 0,
      "lastRefreshedAt": "2019-08-24T14:15:22Z",
      "refreshingUntil": "2019-08-24T14:15:22Z",
      "memberCount": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "hasMore": true,
  "pageNumber": 0,
  "pageSize": 0
}

TypeScript

export interface Response {
  data: {
    id: string;
    ownerId: string;
    name: string;
    description?: string;
    targetType: "contact" | "order" | "ticket";
    kind: "active" | "static";
    filters: {
      logic: "and" | "or";
      conditions: unknown[];
      [k: string]: unknown;
    }[];
    formId?: string;
    folderId?: string;
    status: "active" | "archived";
    trackMembershipEvents: boolean;
    refreshIntervalMs?: number;
    lastRefreshedAt?: string;
    refreshingUntil?: string;
    memberCount?: number;
    createdAt: string;
    updatedAt: string;
  }[];
  hasMore: boolean;
  pageNumber: number;
  pageSize: number;
}