Get Segment

Fetch a segment by id. 404 if absent or owned by another workspace.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Path Parameters

idRequiredstring

Segment id.

Pattern: "^[a-f0-9]{24}$"

GET/v1/segments/{id}

curl -X GET "https://api.3common.com/v1/segments/string" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "segment": {
    "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"
  }
}

TypeScript

export interface Response {
  segment: {
    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;
  };
}