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

# List segments

`GET /v1/segments`

## Request

- Base URL: `https://api.rumoro.dev`
- URL: `https://api.rumoro.dev/v1/segments`
- Auth: HTTP bearer

Returns your saved segments with the current number of people in each, plus presets you can save as a start. Segments are counted on each read and never stored as lists. To see who is in one, send its id to GET /v1/people.

## Response `200`

All segments and the presets

- object
  - `data` object[], required
    - `id` string, required: The segment's id (seg_...).
    - `name` string, required
    - `description` string, required
    - `filter` object, required
      - `platforms` string[]: Only people with a profile on one of these platforms.
      - `tags` string[]: People with one of these tags.
      - `minFollowers` integer: This many followers or more. People with an unknown count are left out.
      - `maxFollowers` integer: This many followers or fewer. People with an unknown count are left out.
      - `minMentions` integer: Minimum number of matched mentions.
      - `minNegative` integer: Minimum number of negative mentions.
      - `intents` string[]: Has a mention tagged with one of these intents.
      - `keywordKinds` string[]: Only people with a mention of these keyword kinds.
      - `neverKeywordKinds` string[]: Excludes people who mentioned these keyword kinds.
      - `notPlatforms` string[]: Leaves out people who have an account on these platforms.
      - `notTags` string[]: Leaves out people with one of these tags.
      - `notIntents` string[]: Excludes people with a mention of these intents.
      - `newSinceDays` integer: People first seen in the past this many days.
      - `linkHosts` string[]: People with a mention that links to one of these hosts or its subdomains.
      - `muted` boolean: true keeps only muted people and false only people who are not muted.
      - `stages` string[]: Only people in one of these outreach stages.
      - `automated` boolean: true keeps people whose matched posts are mostly automated, like bots. false keeps the rest.
      - `ownerIds` string[]: People owned by one of these members, by user id. Use "none" for people without an owner.
    - `count` integer, required: How many people are in the segment now. It is counted again on each read.
    - `createdAt` string, required: UTC time in ISO 8601.
    - `updatedAt` string, required: UTC time in ISO 8601.
  - `presets` object[], required: Suggested filters, ready to save with POST /v1/segments.
    - `key` string, required
    - `name` string, required
    - `description` string, required
    - `filter` object, required
      - `platforms` string[]: Only people with a profile on one of these platforms.
      - `tags` string[]: People with one of these tags.
      - `minFollowers` integer: This many followers or more. People with an unknown count are left out.
      - `maxFollowers` integer: This many followers or fewer. People with an unknown count are left out.
      - `minMentions` integer: Minimum number of matched mentions.
      - `minNegative` integer: Minimum number of negative mentions.
      - `intents` string[]: Has a mention tagged with one of these intents.
      - `keywordKinds` string[]: Only people with a mention of these keyword kinds.
      - `neverKeywordKinds` string[]: Excludes people who mentioned these keyword kinds.
      - `notPlatforms` string[]: Leaves out people who have an account on these platforms.
      - `notTags` string[]: Leaves out people with one of these tags.
      - `notIntents` string[]: Excludes people with a mention of these intents.
      - `newSinceDays` integer: People first seen in the past this many days.
      - `linkHosts` string[]: People with a mention that links to one of these hosts or its subdomains.
      - `muted` boolean: true keeps only muted people and false only people who are not muted.
      - `stages` string[]: Only people in one of these outreach stages.
      - `automated` boolean: true keeps people whose matched posts are mostly automated, like bots. false keeps the rest.
      - `ownerIds` string[]: People owned by one of these members, by user id. Use "none" for people without an owner.

## Other responses

- `401`: The API key is missing or not valid

---

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