---
title: "Get list of users"
method: GET
path: "/v3/spend/users"
tags: ["users"]
---

# Get list of users

`GET /v3/spend/users`

Get a list of user objects in the current user's company. By default, you get 20 results on one page of results. Set `max` in your request to get up to 100 results on one page.

## Query parameters

- `nextPage` string, nullable — Next page of results. When a list has multiple pages, the `nextPage` and `prevPage` values in the response enable you to navigate between the pages of results. Set this field as the `nextPage` value for navigation.
- `prevPage` string, nullable — Previous page of results. Set this field as the `prevPage` value for navigation.
- `max` integer, nullable — Maximum number of results
- `filters` string, nullable — Field name, operator, and value. You can set multiple filters. The format is `filters={field_01}:{op}:{value},{field_02}:{op}:{value}`. Example: `filters=retired:eq:true` The filterable fields are: - `retired` - `true` or `false`. Operators: `eq`.

## Headers

- `apiToken` string, nullable — Access token for Spend & Expense API authentication

## Response `200`

Get list of users response

- PaginatedUsersResponseDto — Response from a list API request with paging references.
  - `nextPage` string — Next page token
  - `prevPage` string — Previous page token
  - `results` UserResponseDto[] — Results
    - `id` string — BILL-generated ID of the user
    - `uuid` string — BILL-generated UUID of the user
    - `firstName` string — User first name
    - `lastName` string — User last name
    - `email` string — User email address
    - `receiptEmail` string — Receipt categorization email address
    - `retired` boolean — Set as `true` if the user is deleted
    - `useCompanyMailingAddress` boolean — Set as `true` if the company email address is set for the user
    - `smsOptIn` boolean — Set as `true` if SMS notifications are enabled for the user
    - `hasDateOfBirth` boolean — Set as `true` if the user date of birth is set
    - `role` 'ADMIN' | 'APPROVER' | 'AUDITOR' | 'BOOKKEEPER' | 'MEMBER' | 'FINANCE_ADMIN' | 'NO_ACCESS' — User role
    - `phoneNumber` string — User phone number
    - `createdTime` string, date-time — User created date and time

## Other responses

- `4XX` — List of errors.
- `5XX` — List of errors.

---

[API](https://skmtc.net/bill/apis/bill-v3-api.md) · [All operations](https://skmtc.net/bill/apis/bill-v3-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bill/bill-v3-api/revisions/0483350c434e/schema)