v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB
budgets

Get list of budget members

Get a list of user members assigned to an existing budget. By default, you get 20 results on one page of results. Set max in your request to get up to 100 results on one page.

get/v3/spend/budgets/{budgetId}/members

Path parameters

budgetIdstring required

BILL-generated ID or UUID of the budget

Example:{{se_budget_uuid}}

Query parameters

maxinteger nullable

Maximum number of results

Example:10
nextPagestring nullable

Next page of results.

When a list has multiple pages, the nextPage and prevPage values in the response enable you to navigate between the pages of results. Set this field as the nextPage value for navigation.

prevPagestring nullable

Previous page of results. Set this field as the prevPage value for navigation.

sortstring nullable

Field name and sort order. You can set only one sort field.

The format is sort={field}:{sort_order}.

The sortable fields are:

  • name
  • spent
Example:spent:desc
filtersstring nullable

Field name, operator, and value. You can set multiple filters.

The format is filters={field_01}:{op}:{value},{field_02}:{op}:{value}.

Example: filters=retired:eq:true

The filterable fields are:

  • retired - true or false. Operators: eq.
Example:retired:eq:false

Headers

apiTokenstring nullable

Access token for Spend & Expense API authentication

Example:{{api_token}}

Response

Get list of budget members response

nextPagestring

Next page token

prevPagestring

Previous page token