Get Segment

Read one manual segment and its member count with GET /v2/admin/segments/{segmentId}.

Returns one active manual segment and how many users it contains. Dynamic or system-generated segments return 409.

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/%7BsegmentId%7D

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.

Path parameters

segmentIdstringRequired

Segment UUID from Create Segment or the dashboard.

Examples

cURL

curl 'https://api.encatch.com/engage-product/encatch/api/v2/admin/segments/550e8400-e29b-41d4-a716-446655440000' \
  -H 'X-Api-Key: YOUR_ADMIN_API_KEY'

Success response

200Response

{
  "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",
  "memberCount": 42
}

segmentIdstringRequired

Segment UUID.

namestring

Segment name.

descriptionstring

Segment description.

createdAtstring

Creation time (UTC).

updatedAtstring

Last update time (UTC).

memberCountnumberRequired

Number of users currently in the segment.

Errors

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

404Error

{
  "status": 404,
  "error": "Not Found",
  "message": "Segment not found"
}

Status	When
`404`	Segment not found, deleted, or invalid UUID (`Segment not found`)
`409`	Not a manual segment (`Only manual segments can be changed through the API`)