---
title: "List"
method: GET
path: "/segments/list"
tags: ["Segments"]
---

# List

`GET /segments/list`

List segments

## Query parameters

- `from` string
- `limit` integer

## Headers

- `X-Batch-Project` string, required

## Response `200`

If the GET to the API endpoint is successful you will receive an HTTP 200 confirmation and information about you segments.

- object
  - `segments` OneSegment[] — An array of objects describing each segment
    - `code` string
    - `display_name` string
    - `created_at` string — UTC Date in a RFC 3339 format
    - `updated_at` string — UTC Date in a RFC 3339 format
  - `count` integer — The total number of objects.
  - `has_more` boolean — Whether or not there are more elements available after this set. If `false`, this set comprises the end of the list.
  - `next_from` string — A cursor for use in pagination. If has_more is `true`, you can pass the value of `next_from` to a subsequent call to fetch the next page of resutls.

## Other responses

- `400` — The request is malformed
- `401` — The Rest API Key is not valid for this project
- `429` — Too Many Requests
- `500` — Unexpected error
- `503` — Batch's services are under maintenance. Please try again later

---

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