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

# List segments

`GET /orgs/segments`

## Request

- Base URL: `https://api.useinvent.com`
- URL: `https://api.useinvent.com/orgs/segments`
- Auth: HTTP bearer

Get a list of segments for a specific org.

## Query parameters

- `search` string: Filter segments by name.
- `page` number
- `take` number
- `next` string
- `progressive` boolean

## Response `200`

- SegmentSchema[]
  - `id` string, required
  - `name` string, required
  - `color` 'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral', required: Accent color, by name
  - `contacts_count` number, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

---

[API](https://skmtc.dev/useinvent/apis/invent-api.md) · [All operations](https://skmtc.dev/useinvent/apis/invent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useinvent/apis/invent-api/revisions/98824f3fde82?raw)