Skip to main content
GET
Get a Segment by Code

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

segmentCode
string
required

(Required) The segment code.

Response

OK

contactQueryId
integer | null

The saved contact query used by this segment.

receiptSegmentId
integer | null

The segment used for receipting.

id
string

The unique identifier of the record in Virtuous.

name
string

The display name of the record.

description
string

The free-text description stored on the record.

code
string
communicationId
string
communicationName
string
campaignId
string
campaignName
string
segmentOrganizerId
string
Last modified on October 1, 2026