List segments

List segments

GET /api/v1/segments

cURL

curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.stateset.com/api/v1/segments' \
  --header "Authorization: Bearer $STATESET_API_KEY"

200

{
  "segments": [
    {
      "created_at": "2026-08-31T14:22:05Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "member_count": 1,
      "name": "Two-Person Tent",
      "segment_type": "string"
    }
  ],
  "total": 102
}

Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.

Query parameters

limit · integer (int32)

offset · integer (int32)

search · string

Response

SegmentListResponse

segments · SegmentResponse[] · required

Show SegmentResponse

created_at · string · required

id · string · required

member_count · integer (int64) · required

Minimum: 0.

name · string · required

segment_type · string · required

total · integer · required

Minimum: 0.

Status codes

Code	Meaning
200	—

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.

cURL

curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.stateset.com/api/v1/segments' \
  --header "Authorization: Bearer $STATESET_API_KEY"

200

{
  "segments": [
    {
      "created_at": "2026-08-31T14:22:05Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "member_count": 1,
      "name": "Two-Person Tent",
      "segment_type": "string"
    }
  ],
  "total": 102
}