Weel API (v1)

The Weel API empowers businesses with seamless expense management and real-time insights. Our platform makes it easy to integrate and automate expense workflows, manage receipts, and keep track of spending across your organization.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://help.letsweel.com

Contact our support

help@letsweel.com

Terms of Service

Languages
Servers

https://public.letsweel.com/

Users

This group of endpoints allows you to retrieve and manage user data, including listing users and fetching individual user details.

Operations

List users

Request

This endpoint allows you to retrieve a list of users for a given business.

Path
client_idintegerrequired

The ID of the business.

Example: 123
Query
offsetinteger

Offset to retrieve items from.

Default 0
Example: offset=50
limitinteger<= 500

Number of items per page.

Default 50
Example: limit=50
curl -i -X GET \
  'https://public.letsweel.com/v1/businesses/123/users?limit=50&offset=50' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
countinteger

The total number of users that match the query.

Example: 100
nextstring

The URL to the next page of users.

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

The URL to the previous page of users.

Example: "offset=0&limit=50"
resultsArray of objects(User)
Response
application/json
{
  "count": 100,
  "next": "offset=50&limit=50",
  "previous": "offset=0&limit=50",
  "results": [
    { … }
  ]
}

Get user

Request

This endpoint allows you to retrieve a user by their ID.

Path
client_idintegerrequired

The ID of the business.

Example: 123
user_idintegerrequired

The ID of the user.

curl -i -X GET \
  'https://public.letsweel.com/v1/businesses/123/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idinteger

The ID of the user.

Example: 123
first_namestring

The first name of the user.

Example: "John"
last_namestring

The last name of the user.

Example: "Doe"
namestring

The full name of the user or the display name if the user has set one.

Example: "John Doe"
emailstring(email)

The email of the user.

Example: "john.doe@example.com"
rolestring

The role of the user.

Example: "Team Member"
is_deletedboolean

Whether the user is deleted.

Example: false
Response
application/json
{
  "id": 123,
  "first_name": "John",
  "last_name": "Doe",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "role": "Team Member",
  "is_deleted": false
}

Transactions

This group of endpoints allows you to retrieve and manage transaction data, including listing transactions with various filters and fetching individual transaction details.

Operations

Budgets

This group of endpoints allows you to retrieve and manage budget data, including listing budgets and fetching individual budget details.

Budgets are organised in a hierarchy where a budget can have multiple members. Each member is associated with a user. Funds can be allocated at the budget level or at the member level, using the flag has_member_limits.

Budget Hierachy

Operations

Budget Members

This group of endpoints allows you to retrieve and manage budget member data, including listing budget members and fetching individual budget member details.

Operations

Budget Topups

This group of endpoints allows you to retrieve and create budget topups. Topups are used to increase or decrease the available amount of a budget or budget member.

Topups will be automatically approved, unless a Workflow or Policy has been configured in Weel for that requires approval for budget topups.

There are two types of topups:

  • Budget topups are used to increase or decrease the available amount of a budget. This is only permitted when has_member_limits is false for the budget.
  • Budget member topups are used to increase or decrease the available amount of a budget member. This is only permitted when has_member_limits is true for the budget.

has_member_limits is set to true when this toggle is enabled in the budget creation form. Has Member Limits is true

Operations