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

# List audience segments

`GET /v1/audience-segments`

Retrieve a paginated list of audience segments, most recently created first.

## Query parameters

- `perPage` string
- `cursor` string

## Response `200`

Successful.

- ListAudienceSegmentsResponse
  - `pagination` Pagination, required
    - `totalResults` number, required
    - `returnedResults` number, required
    - `perPage` number, required
    - `totalPages` number, required
    - `nextCursor` string, nullable, required
    - `nextPage` string, nullable, required
  - `data` AudienceSegment[], required
    - `id` string, required — The ID of the audience segment.
    - `name` string, required — The name of the audience segment.
    - `description` string, nullable, required — An optional description of the audience segment.
    - `createdAt` string, required — ISO 8601 timestamp for when the audience segment was created.
    - `updatedAt` string, required — ISO 8601 timestamp for when the audience segment was last updated.
    - `filter` AudienceFilter, nullable, required — A tree of audience conditions combined with `match`.
      - `match` 'all' | 'any', required
      - `conditions` AudienceFilterCondition[], required
        - union
          - PropertyCondition — Matches contacts by a property value.
            - `type` 'property', required
            - `key` string, required — The contact property name.
            - `operator` 'any' | 'contains' | 'notContains' | 'equals' | 'notEquals' | 'greaterThan' | 'lessThan' | 'isTrue' | 'isFalse' | 'empty' | 'notEmpty' | 'dateEmpty' | 'dateNotEmpty' | 'after' | 'before' | 'between', required
            - `value` union — The comparison value. Omitted for value-less operators (e.g. `isTrue`, `empty`). A `{ from, to }` object for `between`.
              - …
          - OptInCondition — Matches contacts by mailing-list opt-in status.
            - `type` 'optIn', required
            - `status` 'accepted' | 'pending' | 'rejected' | 'null', nullable, required
          - ActivityCondition — Matches contacts by their activity on a campaign or workflow.
            - `type` 'activity', required
            - `action` 'sent' | 'opened' | 'clicked', required
            - `negate` boolean, required
            - `target` 'campaign' | 'workflow' | 'workflowEmail', required
            - `id` string, required — The ID of the campaign, workflow, or workflow email.

## Other responses

- `400` — Invalid `perPage` value.
- `401` — Invalid API key or content API not enabled for this team.
- `405` — Wrong HTTP request method.

---

[API](https://skmtc.net/loops/apis/loops-openapi-spec.md) · [All operations](https://skmtc.net/loops/apis/loops-openapi-spec/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/loops/loops-openapi-spec/revisions/9cc087257f0d/schema)