UPupvest
Account Groups

Get account groups

Changed on

Returns a paginated list of account groups.

Use the offset and limit query parameters to page through results; meta.total_count gives the total number of matching account groups. Both user and business account groups are returned.

See the Accounts overview (TOL / BYOL / Omnibus) for account group types and the account hierarchy.

get/account_groups

Request

  • Base URL
    https://sandbox.upvest.co
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://sandbox.upvest.co/auth/token
    Scopesaccounts:read, accounts:admin

Query parameters

sort'created_at' | 'updated_at'

The field to sort the results by. One of created_at or updated_at; defaults to created_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

  • c8a00277f131Revision changes
    • warning

      added the new PENSION_DE_CHILD enum value to the /// response property for the response status

  • 85aff1852bf8Revision changes
    • warning

      added the new JOINT enum value to the /// response property for the response status