---
title: "List budget members"
method: GET
path: "/v1/businesses/{client_id}/budgets/{budget_id}/members"
tags: ["Budget Members"]
---

# List budget members

`GET /v1/businesses/{client_id}/budgets/{budget_id}/members`

## Request

- Base URL: `https://public.letsweel.com`
- URL: `https://public.letsweel.com/v1/businesses/{client_id}/budgets/{budget_id}/members`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/letsweel/apis/weel-openapi/docs/v1/businesses/:client_id/budgets/:budget_id/members/get.ts> (a function with typed inputs; its response is checked against the schema)

A budget member is a user who has been invited to a budget.

## Path parameters

- `client_id` integer, required
- `budget_id` string, required

## Query parameters

- `offset` integer
- `limit` integer
- `is_deleted` boolean
- `user_id` integer

## Response `200`

OK

- BudgetMemberListResponse
  - `count` integer: The total number of budget members that match the query.
  - `next` string: The URL to the next page of budget members.
  - `previous` string: The URL to the previous page of budget members.
  - `results` BudgetMember[]
    - `id` string: The ID of the budget member.
    - `user` SubUser, nullable
      - `id` integer: The ID of the user.
      - `first_name` string: The first name of the user.
      - `last_name` string: The last name of the user.
      - `name` string: The full name of the user or the display name if the user has set one.
    - `invite` Invite
      - `id` integer: The ID of the invite.
      - `email` string, email: The email address the invite was sent to.
      - `role_id` string, uuid: The ID of the role assigned to the invitee.
      - `role` string: The name of the role assigned to the invitee.
      - `payment_types` PaymentType[]: The payment types the invitee will have access to.
      - `used` boolean: Whether the invite has been accepted.
      - `created` string, date-time: The date and time the invite was created in UTC.
      - `updated` string, date-time: The date and time the invite was last updated in UTC.
    - `available_amount` number: The available amount of the budget member.
    - `spent_amount` number: The amount of the budget that has been spent by the budget member.
    - `reset_amount` number: The reset amount of the budget member.
    - `is_deleted` boolean: Whether the budget member is deleted.
    - `created` string, date-time: The date and time when the budget member was created in UTC.
    - `updated` string, date-time: The date and time when the budget member was last updated in UTC.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

## Changes

- **2026-09-23** `4c7e73b7c4e9`: 1 warning
  - added the new `external_expenses` enum value to the `results/items/invite/payment_types/items/` response property for the response status `200`

[Operation history](https://skmtc.dev/letsweel/apis/weel-openapi/changes/v1/businesses/:client_id/budgets/:budget_id/members/get.md)

---

[API](https://skmtc.dev/letsweel/apis/weel-openapi.md) - [All operations](https://skmtc.dev/letsweel/apis/weel-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/letsweel/apis/weel-openapi/revisions/b1e30cdf67f3?raw)