---
title: "To get segments for given reservation Ids"
method: GET
path: "/v1/Insights/Segments"
tags: ["FlexV1InsightsSegments"]
---

# To get segments for given reservation Ids

`GET /v1/Insights/Segments`

To get segments for given reservation Ids

## Query parameters

- `SegmentId` string
- `ReservationId` string[]
- `PageSize` integer
- `Page` integer
- `PageToken` string

## Headers

- `Authorization` string

## Response `200`

OK

- object
  - `segments` FlexV1InsightsSegments[]
    - `segment_id` string, nullable — To unique id of the segment
    - `external_id` string, nullable — The unique id for the conversation.
    - `queue` string, nullable
    - `external_contact` string, nullable
    - `external_segment_link_id` string, nullable — The uuid for the external_segment_link.
    - `date` string, nullable — The date of the conversation.
    - `account_id` string, nullable — The unique id for the account.
    - `external_segment_link` string, nullable — The hyperlink to recording of the task event.
    - `agent_id` string, nullable — The unique id for the agent.
    - `agent_phone` string, nullable — The phone number of the agent.
    - `agent_name` string, nullable — The name of the agent.
    - `agent_team_name` string, nullable — The team name to which agent belongs.
    - `agent_team_name_in_hierarchy` string, nullable — he team name to which agent belongs.
    - `agent_link` string, nullable — The link to the agent conversation.
    - `customer_phone` string, nullable — The phone number of the customer.
    - `customer_name` string, nullable — The name of the customer.
    - `customer_link` string, nullable — The link to the customer conversation.
    - `segment_recording_offset` string, nullable — The offset value for the recording.
    - `media` unknown
    - `assessment_type` unknown
    - `assessment_percentage` unknown
    - `url` string, uri, nullable
  - `meta` object
    - `first_page_url` string, uri
    - `key` string
    - `next_page_url` string, uri, nullable
    - `page` integer
    - `page_size` integer
    - `previous_page_url` string, uri, nullable
    - `url` string, uri

## Changes

- **2025-07-03** (v1) `0e4cd336d78a` — 3 breaking
  - the `segments/items/assessment_percentage` response's property type changed from `object` to no type for status `200`
  - the `segments/items/assessment_type` response's property type changed from `object` to no type for status `200`
  - the `segments/items/media` response's property type changed from `object` to no type for status `200`
- **2025-03-11** (v1) `65f781b3f6b1` — 3 breaking
  - the `segments/items/assessment_percentage` response's property type changed from no type to `object` for status `200`
  - the `segments/items/assessment_type` response's property type changed from no type to `object` for status `200`
  - the `segments/items/media` response's property type changed from no type to `object` for status `200`
- **2025-02-20** (v1) `4f95f0ad0bf6` — 1 breaking
  - for the `query` request parameter `PageSize`, the format changed from no format to `int64`
- **2023-08-10** (v1) `c37c20a0a1cb` — 1 info
  - api tag `FlexV1InsightsSegments` added
- **2023-05-18** (v1) `350c4958f8a3` — 1 warning, 1 info
  - deleted the `header` request parameter `Token`
  - added the new optional `header` request parameter `Authorization`

[Full history](https://skmtc.dev/twilio/apis/twilio-flex/changes/v1/Insights/Segments/get.md)

---

[API](https://skmtc.dev/twilio/apis/twilio-flex.md) · [All operations](https://skmtc.dev/twilio/apis/twilio-flex/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/twilio/twilio-flex/revisions/ea1db919b6cc/schema)