Appearance

Get Segments ​

Endpoint ​

http
GET /unified/marketing-automation/segments/{id}
Integrations supported
  • ActiveCampaign
  • Beehiiv
  • Customer.io
  • Flodesk
  • Klaviyo

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
workspace
object

The workspace associated with the segment

Required in
  • Beehiiv
id
string

The workspace's unique identifier

Response Body ​

id
string
REQUIRED · 

The segment's unique identifier

Supported in
  • ActiveCampaign
  • Beehiiv
  • Customer.io
  • Flodesk
  • Klaviyo
name
string

The segment's name

Supported in
  • ActiveCampaign
  • Beehiiv
  • Customer.io
  • Flodesk
  • Klaviyo
description
string

The segment's description

Supported in
  • Customer.io
  • Klaviyo
status
string

The segment's computation status

All possible enum values:
  • active
  • pending
  • processing
  • inactive
  • failed
Supported in
  • Beehiiv
  • Customer.io
  • Klaviyo
is_starred
boolean

Whether the segment is starred

Supported in
  • Klaviyo
updated_at
string · date-time

The date and time of the segment's last update

Supported in
  • ActiveCampaign
  • Klaviyo
created_at
string · date-time

The date and time of the segment's creation

Supported in
  • ActiveCampaign
  • Flodesk
  • Klaviyo
last_calculated_at
string · date-time

The date and time of the segment's last calculation

Supported in
  • Beehiiv
remote_data
object

Raw data returned from the remote API call.