Sign in
latestOpenAPI 3.0.42026-08-2211752834.3 KB

fa74265a328d

Segment

Get entity from Segment by key

get/Segment({Id})

Path parameters

Idnumber nullable required

Id of the Segment

Query parameters

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved entity

Idnumber

Internal identifier for ChurnZero.

Entity'Account' | 'Contact' | 'Event' | 'Task' | 'CustomListOpportunities' | 'CustomListExpansionUpsellTracking' | 'CustomListProductsPurchased' | 'CustomListTicket' | 'CustomListExecutiveBusinessReviewGoals' | 'CustomListProductFeedback' | 'CustomListCourseCompletions' | 'CustomListQuizCompletion' | 'CustomListHigherLogicVanillaActivity' | 'CustomListSalesToCSHandoff' | 'CustomListCustomerSuccessStory' | 'CustomListCommitments' | 'CustomListCourseActivity' | 'CustomListSuccessPlan' | 'CustomListStrategicInitiatives' | 'CustomListFinancialData' | 'CustomListCampaigns' | 'CustomListAIProductFeedback' | 'CustomListAISuccessStories'

The type of record this Segment filters. Through this API, one of: Account, Contact, Event, Task, or a Custom Table list name (starting with "CustomList").

IsGlobalboolean

True if the Segment is global — shared with and visible to all users in the tenant. Non-global Segments are private to their owner.

Namestring

The name of the Segment.

ObjectCreatedDatestring date-time

The date/time the Segment record was created. ISO 8601 formatted string.

ObjectLastModifiedDatestring date-time

The date/time the Segment record was last modified. ISO 8601 formatted string.

UserAccountIdnumber

The Id of the UserAccount who owns this Segment; see the UserAccount entity.