---
title: "List segments"
method: POST
path: "/v2beta/track/segment/listSegments-rev2"
tags: ["Segment"]
---

# List segments

`POST /v2beta/track/segment/listSegments-rev2`

## Request

- Base URL: `https://api.karte.io`
- URL: `https://api.karte.io/v2beta/track/segment/listSegments-rev2`
- Auth: HTTP bearer

セグメント一覧を取得します。ドメイン（ドメイン管理機能を利用中の場合）やフォルダでフィルタリングでき、ページネーション機能を持ちます。

#### Required Scope
APIの実行に必要なScopeです。
```
beta.track.segment.listSegments-rev2
```

#### Required Role
管理画面でScopeを追加する際に必要な権限です。
```
基本機能 > 基本ページの閲覧
```

## Headers

- `x-karte-api` string
- `authorization` string
- `content-type` string

## Request body

- object
  - `data` object, required
    - `domain_id` string: ドメインIDでフィルタ（ドメイン管理機能が有効なプロジェクトでのみ利用）
    - `folder_id` string: フォルダIDでフィルタ（MongoDB ObjectId、24文字）。省略時は全フォルダ。
    - `with_archived` boolean: アーカイブ済みセグメントを含む
    - `limit` integer: 取得件数（最大1000）
    - `offset` integer: オフセット（最大10000）

## Response `200`

Success

- object
  - `data` object, required
    - `success` boolean, required: 処理成功フラグ
    - `data` object[], required: セグメント一覧
      - `shorten_id` string, required: セグメントID
      - `name` string, required: セグメント名
      - `description` string: 説明
      - `folder_id` string, nullable, required: フォルダID（未分類は null）
      - `is_archived` boolean, required: アーカイブ済みかどうか
      - `domain_id` string: ドメインID（ドメイン管理機能が有効な場合のみ含まれる）
    - `total` integer, required: 総件数
    - `has_more` boolean, required: 次のページがあるかどうか

---

[API](https://skmtc.dev/karte/apis/insight.md) - [All operations](https://skmtc.dev/karte/apis/insight/llms.txt) - [OpenAPI document](https://skmtc.dev/karte/apis/insight/revisions/0081a93c4d1d?raw)