Read one version of a Segment

Search Documentation

Search across all developer documentation

segments

Read one version of a Segment

GET /v1/segments/{id}/versions/{version}
Auth required api.segments.view

The full snapshot of one version: every author-editable field as it stood, plus who made the edit that replaced it.

Path parameters

id string required

The Segment's UUID or its org-unique key.

version integer required

The version number, as returned by the versions collection. Version numbers are the handle on every kind here, including the kinds whose dashboard routes address a version by row id.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 The version snapshot application/json
kind string enum required

One of: segments, workflows, templates, attributes, activity-properties, lists, topics

version_number integer required
created_at string<date-time> required
actor object required

Who made one edit. The label is resolved server-side — a person's name, an API key's name, an OAuth client's name — because the name lives in a different table per kind and a client can read none of them. It never carries a key, a token or a client secret; a revoked credential falls back to a short form of its id rather than rendering blank.

Fields of actor:

kind string enum required

unknown is an honest value rather than an error: it is what rows predating actor recording carry, and what a write reached with no credential records.

One of: user, api_key, oauth_client, system, unknown

id string optional

The users / api_keys / oauth_clients id, per kind. Absent for system and unknown.

label string required
session string optional

The HTTP request id of the edit — the same value on the matching audit row, so the two can be joined. It is NOT an MCP session id: the MCP transport is stateless and reads no session header.

content_hash string optional
name string optional
key string optional

The immutable handle. Provenance on a snapshot — no restore changes a key.

description string optional
source string optional

The author-editable text of a source kind: the SendQL predicate, the .flow document, the Handlebars body. Absent for the schema kinds, and absent where the caller's scope does not reach it.

source_withheld string optional

The scope that would return source, set only when that is why it is absent.

subject string optional
type string optional
enum_values array<string> optional
activity_name string optional
property_name string optional
display_name string optional
default_subscription_status string optional
profile_version integer optional
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json