STstuut
customer-segments

List Customer Segments

Returns all customer segments for the organization, ordered by priority.

get/v2/customer-segments

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, 0 indexed.

limitinteger

Number of records per page.

searchstring nullable

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
namestring required

The name of the segment (case-insensitive unique per org).

descriptionstring nullable required

Optional description of what this segment represents.

priorityinteger required

Lower number = higher priority for conflict resolution when partner matches multiple segments.

conditionsobject nullable required

Rules that determine which partners belong to this segment.

partner_countinteger nullable required

Cached number of partners matching this segment.

partner_count_refreshed_atstring date-time required
objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 1 revision of this API.