Businesses

Get all businesses

Changed on

Returns a paginated list of all businesses.

Use offset and limit to paginate through results, and sort/order to control the ordering by created_at or updated_at.

See the Business accounts guide (TOL / BYOL) for business account types.

get/businesses

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/businesses
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: businesses:read, businesses: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

  • 079ede5fe507Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the / response property oneOf list for the response status

  • 7b1640fd8a62Revision changes
    • breaking

      the response property //// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the /// response's property type changed from no type to string for status

    • warning

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

    • info

      the response's property default value LIMITED_LIABILITY_COMPANY was removed for the status