---
title: "List users"
method: GET
path: "/v1/businesses/{client_id}/users"
tags: ["Users"]
---

# List users

`GET /v1/businesses/{client_id}/users`

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

## Path parameters

- `client_id` integer, required

## Query parameters

- `offset` integer
- `limit` integer

## Response `200`

OK

- UserListResponse
  - `count` integer — The total number of users that match the query.
  - `next` string — The URL to the next page of users.
  - `previous` string — The URL to the previous page of users.
  - `results` User[]
    - `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.
    - `email` string, email — The email of the user.
    - `role` string — The role of the user.
    - `role_id` string, uuid — The ID of the user's role.
    - `is_deleted` boolean — Whether the user is deleted.
    - `created` string, date-time — The date and time when the user was created in UTC.
    - `updated` string, date-time — The date and time when the user was last updated in UTC.
    - `payment_types` PaymentType[] — The payment types the user can transact with.
    - `out_of_office_mode` boolean — Whether the user is out of office.
    - `out_of_office_start_date` string, date, nullable — First day of the out-of-office period (inclusive).
    - `out_of_office_end_date` string, date, nullable — Last day of the out-of-office period (inclusive).
    - `delegate_approver` integer, nullable — The user ID to delegate approvals to while out of office.
    - `expense_delegate` integer[], nullable — The user IDs of this user's expense assistants (who can act on their expenses). Null if the business does not have the expense assistant feature.

## 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/revisions/5a8ffd533c9c/schema)
