Skip to main content
GET
/
segments
List segments
curl --request GET \
  --url https://api.wacht.dev/segments \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "1234567890123456789",
      "deployment_id": "9876543210987654321",
      "name": "Premium Users",
      "type": "user",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

API key authentication (format: Bearer {api_key})

Query Parameters

offset
integer
default:0

Number of items to skip

Required range: x >= 0
limit
integer
default:20

Number of items to return

Required range: 1 <= x <= 100

Search query

sort_key
string

Field to sort by

sort_order
enum<string>

Sort order

Available options:
asc,
desc

Response

200 - application/json

Segments

data
object[]
has_more
boolean

Whether there are more results

limit
integer | null

Page size

offset
integer | null

Number of items skipped