Skip to main content
QUERY
segmentV2(_id: String!): SegmentV2

Arguments

_id
String!
required

Segment id.

Returns

SegmentV2
_id
String!

Unique segment identifier.

tenantId
String!

Owning workspace/tenant id.

name
String!

Display name shown in segment pickers.

description
String

Optional free-text description.

status
String!

Lifecycle status (e.g. active, archived). See segmentV2Archive / segmentV2Unarchive.

type
String!

Segment kind — static (explicit member list) or dynamic (rule-evaluated).

activeVersion
Int!

Version number currently serving reads and campaign targeting.

draftVersion
Int

Unpublished version staged by segmentV2SaveDraft. null when there is no pending draft.

buildingVersion
Int

Version currently being rebuilt, if any. Non-null means membership counts may be stale until the rebuild completes.

dependencyKeys
[String]

Internal keys this segment's rule depends on (e.g. referenced fields/segments).

evaluator
SegmentV2EvaluatorState

Rebuild/evaluation state. See SegmentV2EvaluatorState.

usageState
String!

How this segment is currently used (e.g. campaign targeting, general purpose).

lastReadAt
Date

Timestamp of the last time membership was read.

emitsMembershipEvents
Boolean!

When true, membership enter/exit changes emit events for downstream automations. Set via segmentV2SaveDraft.

createdBy
String

User id that created this segment.

createdAt
Date

When this segment was created.

updatedBy
String

User id of the last editor.

updatedAt
Date

When this segment was last modified.

readyForCampaign
Boolean

true when the segment has a published active version and is not currently rebuilding. Prefer segmentV2AssertReadyForCampaign when checking multiple segments before launching a campaign.

Query
Variables
Response
آخر تعديل في ١١ أغسطس ٢٠٢٦