---
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`

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

---

[API](https://skmtc.net/letsweel/apis/weel-openapi.md) · [All operations](https://skmtc.net/letsweel/apis/weel-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/letsweel/weel-openapi/versions/55da5fa350fb/schema)