Users

Get all users

Changed on

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

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/users
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: users:read, users:admin)

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

  • 9a5a2a64d218Revision changes
    • info

      response property data/oneOf[subschema #1]/anyOf[subschema #1: Users (BYOL) - List]/items/status deprecated

    • info

      response property data/oneOf[subschema #1]/anyOf[subschema #2: Users (TOL) - List]/items/status deprecated

  • 725dd12761d9Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status