GET
/
users
cURL
curl --request GET \
  --url http://localhost:8080/users
{
  "data": [
    {
      "created_at": "2026-01-15T12:34:56",
      "last_modified_at": "2026-01-15T12:34:56",
      "phone_country_code": "<string>",
      "phone_number": "<string>",
      "user_id": "012345678901",
      "address": {
        "city": "Bengaluru",
        "country": "IN",
        "line1": "123, MG Road",
        "line2": "Flat 4B, Sunrise Apartments",
        "pincode": "560001",
        "state": "Karnataka"
      },
      "dob": "2000-01-15",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 123
}

Query Parameters

statuses
string | null
sort
object

Sort specification for list endpoints. Read the field names as "sort on <column> by <direction>".

time_range
object

A half-open time range, with a mandatory start and an optional end. Designed to be embedded in list/filter query params via #[serde(flatten)].

Deserialize runs [TimeRange::validate] as part of deserialization, so callers never receive a [TimeRange] that violates start_time <= end_time.

limit
integer<int32> | null
offset
integer<int32> | null

Response

List of users

data
object[]
required
limit
integer<int32>
required
offset
integer<int32>
required
total
integer<int64>
required