---
title: "Get list of all segments"
method: GET
path: "/api-offers/segment/list"
tags: ["Segment"]
---

# Get list of all segments

`GET /api-offers/segment/list`

## Request

- Base URL: `https://live.copilot.fabric.inc`
- URL: `https://live.copilot.fabric.inc/api-offers/segment/list`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/fabric/apis/offers-v2/docs/api-offers/segment/list/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a paginated list of segments based on query parameters.

## Query parameters

- `limit` number
- `offset` number

## Headers

- `x-site-context` string, required

## Response `200`

OK

- ListSegmentResponse
  - `query` GenericListQueryResponse: Paging details used for selecting list
    - `limit` number: The maximum number of records per page.
    - `count` number: The total number of records.
    - `offset` number: The number of records to skip before returning records. For example, when offset is 20 and limit is 10, this endpoint returns records from 21 to 30.
  - `data` GetSegmentResponse[]: Segment information
    - `_id` string: fabric internal database ObjectId of the record
    - `segmentId` number: System generated unique ID of the Segment
    - `name` string: Name of the segment
    - `value` string[]: Array of segment values
    - `deleted` boolean: true: segment is deleted<br /> false: segment is not deleted
    - `createdAt` string, date-time: Creation date of the record
    - `updatedAt` string, date-time: Last updated date of the record

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/fabric/apis/offers-v2.md) - [All operations](https://skmtc.dev/fabric/apis/offers-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/fabric/apis/offers-v2/revisions/da2bd742b9bc?raw)