Skip to content

List customer segments

GET/customer360/segments

Returns a paginated list of all customer segments ordered by most recently updated. Segments define rule-based groupings of customer profiles used for targeting journeys, campaigns, and personalisation.

Request

Query parameters

NameTypeRequiredDescription
pageintegerNo

Default: 1

Responses

200 Paginated segment list

Content type application/json, object.

FieldTypeRequiredDescription
dataarray of object · CustomerSegmentV1No
data[].idintegerNo

Auto-incremented primary key.

data[].namestringNo

Segment display name.

Example: "Enterprise Fintech"

data[].descriptionstring, nullableNo

Human-readable description of the segment's membership criteria.

data[].statusstringNo

Lifecycle status. Only 'active' segments can power journeys.

One of: "draft", "active", "archived" · Example: "active"

data[].rulesarray of object, nullableNo

Array of membership rule objects (field, operator, value).

data[].created_byinteger, nullableNo

Tenant user ID who created this segment.

data[].created_atstring (date-time)No

Record creation timestamp.

Example

{
  "data": [
    {
      "id": 7,
      "name": "Enterprise Fintech",
      "description": "All enterprise-tier customers in the fintech industry.",
      "status": "active",
      "rules": [
        {
          "field": "attributes.tier",
          "operator": "equals",
          "value": "enterprise"
        },
        {
          "field": "attributes.industry",
          "operator": "equals",
          "value": "fintech"
        }
      ],
      "created_by": 1,
      "created_at": "2026-02-20T09:00:00Z"
    }
  ]
}

401 Unauthenticated

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/customer360/segments" \
  -H "Accept: application/json"
Loading