Skip to content

Budget Owners

This group of endpoints allows you to retrieve and manage budget owners. A budget owner is a user (or pending invite) who can approve spend, top up, and otherwise manage the budget.

A budget must always have at least one active owner — deleting the last remaining owner is not permitted. Adding an owner who was previously removed will reinstate the original record rather than create a duplicate.

Operations

List budget owners

Request

Lists owners of the budget.

Security
BearerAuth
Path
client_idintegerrequired

The ID of the business.

Example:123
budget_idstringrequired

The ID of the budget.

Query
offsetinteger

Offset to retrieve items from.

Default:0
Example:offset=50
limitinteger, <= 500

Number of items per page.

Default:50
Example:limit=50
is_deletedboolean

Whether the resource is deleted.

Example:is_deleted=false
GET
/v1/businesses/{client_id}/budgets/{budget_id}/owners
curl -i -X GET \
  'https://public.letsweel.com/v1/businesses/123/budgets/{budget_id}/owners?offset=50&limit=50&is_deleted=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
countinteger

The total number of budget owners that match the query.

Example:3
nextstring

The URL to the next page of budget owners.

Example:"offset=50&limit=50"
previousstring

The URL to the previous page of budget owners.

Example:"offset=0&limit=50"
resultsArray of objects(BudgetOwner)
Response
{
  "count": 3,
  "next": "offset=50&limit=50",
  "previous": "offset=0&limit=50",
  "results": [
    { … }
  ]
}