---
title: "View segments"
method: GET
path: "/apps/{app_id}/segments"
---

# View segments

`GET /apps/{app_id}/segments`

Retrieve a list of segments associated with a specific OneSignal app. Useful for programmatically accessing segment metadata such as name, creation date, and status.

## Path parameters

- `app_id` string, required

## Query parameters

- `offset` integer
- `limit` integer

## Headers

- `Authorization` string, required

## Response `200`

200

- object
  - `total_count` integer — The total number of segments available for the app.
  - `offset` integer — Value set in the `offset` query parameter.
  - `limit` integer — Value set in the `limit` query parameter.
  - `segments` object[]
    - `id` string — The unique identifier for the segment in UUID v4 format.
    - `name` string — An internal name you set to help organize and track Segments. Maximum 128 characters.
    - `description` string, nullable — Human-readable description for the segment. `null` when unset. Maximum 255 characters.
    - `created_at` string — The date and time the segment was created in ISO 8601 format.
    - `updated_at` string — The date and time the segment was last updated in ISO 8601 format.
    - `app_id` string — Your OneSignal App ID in UUID v4 format. See [Keys & IDs](/docs/en/keys-and-ids).
    - `read_only` boolean — Indicates if the segment is read-only.
    - `is_active` boolean — Indicates if the segment is active. `false` means the segment is paused and cannot be used to send messages.

## Other responses

- `400` — 400
- `429` — 429
- `503` — Service temporarily unavailable. Retry after a short backoff. The body may be empty or non-JSON in some failure modes.

---

[API](https://skmtc.net/onesignal/apis/api-onesignal-com.md) · [All operations](https://skmtc.net/onesignal/apis/api-onesignal-com/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onesignal/api-onesignal-com/versions/0fc223f7e338/schema)