---
title: "List segments"
method: GET
path: "/tenants/{slug}/segments"
tags: ["segments"]
---

# List segments

`GET /tenants/{slug}/segments`

## Request

- Base URL: `https://api.animam.ai`
- URL: `https://api.animam.ai/tenants/{slug}/segments`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`
  - OAuth 2 (authorization code, authorization URL `https://api.animam.ai/oauth/authorize`, token URL `https://api.animam.ai/oauth/token`, scopes: `segments:read`)

## Path parameters

- `slug` string, required: Tenant slug (URL-safe identifier).

## Response `200`

List of segments.

- object
  - `segments` SegmentSummary[], required
    - `slug` string, required
    - `name` string, required
    - `isDefault` boolean, required
    - `isActive` boolean, required
    - `corpusCount` integer, required
    - `conversationsCount` integer, required

---

[API](https://skmtc.dev/animam/apis/animam-api.md) · [All operations](https://skmtc.dev/animam/apis/animam-api/llms.txt) · [OpenAPI document](https://skmtc.dev/animam/apis/animam-api/revisions/138c3cf374f1?raw)