Segment
SegmentImplements
Fields
URL of the Segment's avatar image, or null when it has none.
The Segment's display color as a hex code, or null when unset. Visible to hosts and moderators only.
Required scopes: host:read:network, host:read:network_members, host:write:network_members (any one)
The member who created this Segment, or null when none is recorded.
The custom field this Segment is an option of, for tag, badge, and choice Segments.
Plain-text description of the Segment (up to 200 characters). Not HTML.
What this Segment represents (cluster, tag, badge, or choice).
ID of the object.
Whether a member created this Segment, rather than a host.
Whether this Segment is currently pinned to the Network's Featured Members list (Members Explore). Curation state, so host/moderator-only like the mutations that change it. Null for non-managers.
Required scopes: host:read:network, host:read:network_members, host:write:network_members (any one)
Always null; no Segment flavor currently populates this field.
Number of members currently in the Segment. Computed live.
Bounded preview (up to 30) of the Segment's current members, from active
memberships. The authoritative size is memberCount, not this list's length.
Resource ID for this object, for interop with the Admin API.
Canonical URL of the Segment.