Sign in
Users

Get all users

Returns a paginated list of users.

Use the offset and limit query parameters to page through results; meta.total_count gives the total number of matching users. Use sort/order to control ordering by created_at or updated_at.

See the User onboarding guide (TOL / BYOL) for the user lifecycle.

get/users

Query parameters

sort'created_at' | 'updated_at'

Sort the result by created_at, updated_at.

order'ASC' | 'DESC'

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

offsetinteger

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

limitinteger

Use the limit argument to specify the maximum number of items returned.

Response

OK

Changes

Changed in 2 of the 7 revisions of this API.4

  • 725dd12761d92See the full diff
    • ○

      added the optional property data/oneOf[subschema #1]/anyOf[subschema #1: Users (BYOL) - List]/items/decease_date to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/oneOf[subschema #1]/anyOf[subschema #2: Users (TOL) - List]/items/decease_date to the response with the 200 status

      response-optional-property-added

  • 2c6bc192bc092See the full diff
    • ○

      added the optional property data/oneOf[subschema #1]/anyOf[subschema #1: Users (BYOL) - List]/items/tags to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/oneOf[subschema #1]/anyOf[subschema #2: Users (TOL) - List]/items/tags to the response with the 200 status

      response-optional-property-added