---
title: "Get entity from Segment by key"
method: GET
path: "/Segment({Id})"
tags: ["Segment"]
---

# Get entity from Segment by key

`GET /Segment({Id})`

## Path parameters

- `Id` number, nullable, required

## Query parameters

- `$select` string[]
- `$expand` string[]

## Response `200`

Retrieved entity

- ChurnZeroSegment — A configurable, live-updating "smart list" of records that match its filters. Segments back almost every Customer Success workflow in ChurnZero — they target Plays, drive Alerts, scope Surveys, restrict ChurnScores, and filter reports. Segment Entity types include Account, Contact, Event, Message, Task/Activity, Note, Meeting, SurveyResponse, SuccessPlan, Signal, and Custom Table records. This API returns only Segments over entities it exposes (Account, Contact, Event, Task, and Custom Table lists), and only Segments the caller owns or that are global, unless the caller has Full Configuration Control permission.
  - `Id` number — 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").
  - `IsGlobal` boolean — True if the Segment is global — shared with and visible to all users in the tenant. Non-global Segments are private to their owner.
  - `Name` string — The name of the Segment.
  - `ObjectCreatedDate` string, date-time — The date/time the Segment record was created. ISO 8601 formatted string.
  - `ObjectLastModifiedDate` string, date-time — The date/time the Segment record was last modified. ISO 8601 formatted string.
  - `UserAccountId` number — The Id of the UserAccount who owns this Segment; see the UserAccount entity.
  - `UserAccount` object, nullable — A user in your organization — typically a Customer Success Manager, Account Manager, or admin synced from a CRM. UserAccounts are the assignable targets of Account Roles, Tasks, Plays, and Notes, and (when their Can Login flag is true) the people who sign in to ChurnZero.
    - `Id` number — Internal identifier for ChurnZero.
    - `AvatarUrl` string — The URL to this User's avatar image.
    - `CanLogIn` boolean — True if this UserAccount is allowed to log into ChurnZero. UserAccounts that cannot log in can still own Accounts.
    - `CrmId` string — The Id of this UserAccount's linked user record in an external source, such as the tenant's CRM.
    - `Email` string — The User's email address.
    - `FirstName` string — The User's first name.
    - `HasAccounts` boolean — True if this UserAccount owns at least one Account in ChurnZero (see Account.UserAccountId).
    - `IsActive` boolean — True if the UserAccount is active in ChurnZero.
    - `LastName` string — The User's last name.
    - `MobilePhone` string — The User's mobile phone number.
    - `Name` string — The User's full name.
    - `ObjectCreatedDate` string, date-time — The date/time the UserAccount record was created. ISO 8601 formatted string.
    - `ObjectLastModifiedDate` string, date-time — The date/time the UserAccount record was last modified. ISO 8601 formatted string.
    - `OfficePhone` string — The User's office phone number.
    - `Title` string — The User's job title.
    - `UserName` string — The UserName this User uses to log into ChurnZero.

## Other responses

- `400` — Bad Request|This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.
- `401` — Unauthorized|A valid authentication token was not provided with the request, so the API could not associate a user with the request.
- `403` — Forbidden|The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.
- `404` — Not Found|Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.
- `409` — Conflict|The underlying model/schema has changed. Usually caused by a race condition. Sending the request again will succeed.
- `429` — Too Many Requests|You have exceeded one of the enforced rate limits in the API. See the documentation on rate limiting for more information.
- `500` — Internal Server Error|There was a problem on ChurnZeros's end.
- `default` — error

---

[API](https://skmtc.net/churnzero/apis/churnzero-rest-api-for-marketingpony.md) · [All operations](https://skmtc.net/churnzero/apis/churnzero-rest-api-for-marketingpony/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/churnzero/churnzero-rest-api-for-marketingpony/revisions/fa74265a328d/schema)