segments

List dynamic Segments

GET /v1/segments

Auth required api.segments.view

Returns the org's dynamic Segments, newest-first. A Segment's membership is the live truth value of its SendQL source — there is no explicit add/remove. member_count and last_evaluated_at reflect the most recent reconcile. The response includes the source text. Segment management (create/edit/pause) is dashboard-only; this API is read-only.

Query parameters

limit integer optional

Page size (1–200). Default 50.

cursor string optional

Opaque cursor returned from the previous page.

Responses

200 Cursor-paginated list of Segments, newest-first application/json

401 Missing, malformed, or unknown API key application/problem+json

403 Key lacks the required scope or plan limit violated application/problem+json

422 Query parameter or path value failed validation application/problem+json

429 Per-org rate limit exceeded application/problem+json

500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json

curl 'https://api.sendops.dev/v1/segments' \
  -H "Authorization: Bearer $SENDOPS_API_KEY"

const res = await fetch("https://api.sendops.dev/v1/segments", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.SENDOPS_API_KEY}`
  },
});
const body = await res.json();

import os, requests

r = requests.get("https://api.sendops.dev/v1/segments", headers={"Authorization": f"Bearer {os.environ['SENDOPS_API_KEY']}"})
print(r.json())

application/json

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "key": "string",
      "description": "string",
      "source": "string",
      "profile_version": 0,
      "eval_class": "incremental",
      "status": "active",
      "member_count": 0,
      "eval_warning": "string",
      "eval_warning_at": "2026-05-17T20:00:00Z",
      "last_evaluated_at": "2026-05-17T20:00:00Z",
      "origin": "managed",
      "source_path": "string",
      "last_synced_at": "2026-05-17T20:00:00Z",
      "created_at": "2026-05-17T20:00:00Z",
      "updated_at": "2026-05-17T20:00:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "string"
  }
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}

{
  "type": "https://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "invalid_key",
  "request_id": "string",
  "retry_after": 0,
  "retention_days": 0,
  "scope": "string",
  "resource": "string",
  "errors": [
    {
      "field": "string",
      "reason": "string"
    }
  ]
}