Skip to content

Get Segments

Endpoint

http
GET /unified/marketing-automation/segments/{id}
Integrations supported
  • Beehiiv
  • Customer.io
  • 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. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
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.
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
  • Beehiiv
  • Customer.io
  • Klaviyo
name
string
The segment's name
Supported in
  • Beehiiv
  • Customer.io
  • 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
  • Klaviyo
created_at
string · date-time
The date and time of the segment's creation
Supported in
  • 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.