Fees

Get fee collections

Returns the list of fee collections.

Use the offset and limit query parameters to page through results; meta.total_count gives the total number of matching fee collections. Narrow the result set with the account_id and account_group_id query parameters.

See the Fee collection guide (TOL / BYOL) for the collection lifecycle and webhook events.

get/fees/collections

Request

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

Query parameters

account_idstring uuid

Universally Unique Identifier (UUID) of the account.

Filters the list to show only fees associated with a specific account ID.

account_group_idstring uuid

Universally Unique Identifier (UUID) of the account group.

Filters the list to show only fees associated with a specific account group ID.

sort'created_at' | 'updated_at'

Field of resource to sort by.

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

No recorded changes to this operation across all 25 revisions of this API.