v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Budget Members

List budget members

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

get/v1/businesses/{client_id}/budgets/{budget_id}/members

Path parameters

client_idinteger required
Example:123

The ID of the business.

budget_idstring required

The ID of the budget.

Query parameters

offsetinteger
Example:50

Offset to retrieve items from.

limitinteger
Example:50

Number of items per page.

is_deletedboolean

Whether the resource is deleted.

user_idinteger
Example:123

The ID of the user to filter by.

Response

OK

countinteger

The total number of budget members that match the query.

nextstring

The URL to the next page of budget members.

previousstring

The URL to the previous page of budget members.

Example response

{
  "count": 100,
  "next": "offset=50&limit=50",
  "previous": "offset=0&limit=50",
  "results": [
    {
      "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
      "user": {
        "id": 123,
        "first_name": "John",
        "last_name": "Doe",
        "name": "John Doe"
      },
      "invite": {
        "id": 99,
        "email": "jane.doe@example.com",
        "role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "role": "Team Member",
        "payment_types": [
          "cards",
          "reimbursements"
        ],
        "created": "2026-05-01T00:00:00Z",
        "updated": "2026-05-01T00:00:00Z"
      },
      "available_amount": 800,
      "spent_amount": 200,
      "reset_amount": 1000,
      "created": "2024-01-01T00:00:00Z",
      "updated": "2024-01-01T00:00:00Z"
    }
  ]
}