Skip to main content
GET
/
v2
/
customer-segments
/
partners
/
{partner_id}
Get Segment For Partner
curl --request GET \
  --url https://api.example.com/v2/customer-segments/partners/{partner_id} \
  --header 'Authorization: Bearer <token>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "priority": 123,
  "conditions": {},
  "workflows": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "is_active": true,
      "object": "<string>"
    }
  ],
  "object": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
partner_id
string
required

Response

CustomerSegmentWithWorkflows · object | null

Successful Response

​
created_at
string<date-time>
required
​
modified_at
string<date-time> | null
required
​
id
string
required
​
name
string
required

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

​
description
string | null
required

Optional description of what this segment represents.

​
priority
integer
required

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

​
conditions
object
required

Rules that determine which partners belong to this segment.

​
workflows
OutreachWorkflowSummary · object[]
required
​
object
string
required
read-only

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