List Segments

Returns active manual segments for the project, newest first. Data-driven and system-generated segments are not listed here.

Authenticate with an admin API key. Admin API rate limits apply separately from SDK limits.

GEThttps://api.encatch.com/engage-product/encatch/api/v2/admin/segments

Authentication

X-Api-KeystringRequired

Admin (secret) API key

Publishable SDK keys receive 403 (publishable API keys cannot call /v2/admin routes).

Server-side only

Keep admin API keys on your server. Never ship them in client code.

Query parameters

limitnumber

Page size, 1–100. Default 100.

offsetnumber

Rows to skip. Default 0. Must not be negative.

Examples

cURL

curl 'https://api.encatch.com/engage-product/encatch/api/v2/admin/segments?limit=10&offset=0' \
  -H 'X-Api-Key: YOUR_ADMIN_API_KEY'

Success response

200Response

{
  "segments": [
    {
      "segmentId": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Beta testers",
      "description": "Invited to product feedback",
      "createdAt": "2026-09-29T08:00:00Z",
      "updatedAt": "2026-09-29T08:00:00Z"
    }
  ],
  "limit": 10,
  "offset": 0
}

segmentsobject[]Required

Manual segments on this page.

segmentIdstring

Segment UUID.

namestring

Segment name.

descriptionstring

Segment description.

createdAtstring

Creation time (UTC, ISO 8601).

updatedAtstring

Last update time (UTC, ISO 8601).

limitnumberRequired

Page size used for this response.

offsetnumberRequired

Offset used for this response.

Errors

These are specific to List Segments. Shared errors include invalid or missing API key (401), publishable key on admin routes (403), rate limits (429), and sanitized 500 responses.

400Error

{
  "status": 400,
  "error": "Bad Request",
  "message": "Validation error: limit must be between 1 and 100"
}

Status	When
`400`	`limit` not between 1 and 100; negative `offset`

Create Segment
Manual Segments: dashboard workflow