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

# List segments

`GET /v1/projectId/{projectId}/segments`

## Request

- Base URL: `https://api.bluefox.email`
- URL: `https://api.bluefox.email/v1/projectId/{projectId}/segments`
- Auth: HTTP bearer

## Path parameters

- `projectId` string, required

## Query parameters

- `limit` integer
- `skip` integer
- `sort` 'name' | 'createdAt' | 'updatedAt'
- `order` 'asc' | 'desc'
- `filter[<field>]` string

## Response `200`

OK

- object
  - `status` integer
  - `result` object
    - `items` Segment[]
      - `_id` string
      - `name` string
      - `groups` object[]: OR-ed groups of AND-ed conditions - matches the segment builder in the app.
        - `conditions` object[]
          - `category` 'contact-property' | 'engagement'
          - `property` string: A custom contact field name, or "createdAt". Required unless operator is "any" or a tag operator.
          - `operator` 'any' | 'equals' | 'does-not-equal' | 'contains' | 'does-not-contain' | 'is-empty' | 'is-not-empty' | 'is-true' | 'is-false' | 'greater-than' | 'greater-than-or-equal' | 'less-than' | 'less-than-or-equal' | 'has-tag' | 'does-not-have-tag' | 'opened' | 'not-opened' | 'clicked' | 'not-clicked' | 'received' | 'not-received' | 'date-equals' | 'date-before' | 'date-after' | 'date-in-last' | 'date-more-than'
          - `value` unknown
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
    - `count` integer: Total matching items across all pages, not just this page.
    - `next` string, nullable: Full URL (path + query string) of the next page, or null if this is the last page.

## Other responses

- `403`: Missing or invalid API key

---

[API](https://skmtc.dev/bluefox/apis/bluefox-email-public-api.md) · [All operations](https://skmtc.dev/bluefox/apis/bluefox-email-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bluefox/apis/bluefox-email-public-api/revisions/fa1a0a835c7f?raw)