---
title: "Get list of budget members"
method: GET
path: "/v3/spend/budgets/{budgetId}/members"
tags: ["budgets"]
---

# Get list of budget members

`GET /v3/spend/budgets/{budgetId}/members`

## Request

- Base URL: `https://gateway.stage.bill.com/connect`
- URL: `https://gateway.stage.bill.com/connect/v3/spend/budgets/{budgetId}/members`
- Auth: none declared

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.

## Path parameters

- `budgetId` string, required: BILL-generated ID or UUID of the budget

## Query parameters

- `max` integer, nullable: Maximum number of results
- `nextPage` string, 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.
- `prevPage` string, nullable: Previous page of results. Set this field as the `prevPage` value for navigation.
- `sort` string, 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`
- `filters` string, 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`.

## Headers

- `apiToken` string, nullable: Access token for Spend & Expense API authentication

## Response `200`

Get list of budget members response

- PaginatedBudgetMemberResponseDto: Response from a list API request with paging references.
  - `nextPage` string: Next page token
  - `prevPage` string: Previous page token
  - `results` BudgetMemberResponseDto[]: Results
    - `userId` string: BILL-generated ID of the user
    - `userUuid` string: BILL-generated UUID of the user
    - `spent` number: Total amount spent by the user in the current budget period
    - `limit` number: Funds assigned to the user in the current budget period
    - `recurringLimit` number: Funds assigned to the user in all future budget periods
    - `recurring` boolean: Set as `true` if the user receives the `recurringLimit` funds in all future budget periods.
    - `budgetRole` 'MEMBER' | 'OWNER' | 'OBSERVER': Budget user role
    - `name` string: User display name
    - `retired` boolean: Set as `true` if the budget member is retired
    - `shareBudgetFunds` boolean: Set as `true` if all the budget funds are shared with the user

## Other responses

- `4XX`: List of errors.
- `5XX`: List of errors.

---

[API](https://skmtc.dev/bill/apis/bill-v3-api.md) - [All operations](https://skmtc.dev/bill/apis/bill-v3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bill/apis/bill-v3-api/revisions/54edddceb0a5?raw)