Sign in

v1

latestOpenAPI 3.1.02026-07-2466171164.0 KB
Users

Retrieve a paginated list of users

get/v1/users

Query parameters

created_at__gtestring date-time

Filter for records created at or after this timestamp. Default is the epoch start time in UTC.

created_at__ltestring date-time nullable

Filter for records created at or before this timestamp. Default is the current UTC time.

order_by'created_at' | '-created_at'

The ordering of the results. Use 'created_at' for ascending order or '-created_at' for descending order.

  • created_at - created_at
  • -created_at - -created_at
pageinteger

The page number to retrieve, starting from 1.

page_sizeinteger

The number of items per page, maximum is 1000.

Response

A paginated list of users

pageinteger required

The current page number.

page_sizeinteger required

The number of items per page.

created_at__ltestring date-time required

The most recent date for which results are included.

created_at__gtestring date-time required

The least recent date for which results are included.

ordered_by'created_at' | '-created_at' required
pagesinteger required

The total number of pages available.

countinteger required

The total number of items available.