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

# Get list of users

`GET /v3/partner/users`

Get a list of user objects. 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.

See [Search operations with lists](https://developer.bill.com/docs/search-op-with-lists) in the Guides section for filtering, sorting, and pagination examples.

This operation requires partner-level permissions.
* A `sessionId` header value generated with [API partner login](https://developer.bill.com/reference/partnerlogin)
* An `appKey` header value
* The `organizationId` of the organization

## Query parameters

- `max` integer, nullable — Maximum number of results
- `sort` string, nullable — Field name and sort order. Both simple and compound sorting is available. The format is `sort={field_01}:{sort_order},{field_02}:{sort_order}`. **NOTE**: Sorting occurs in the specified order.
- `filters` string, nullable — Field name, operator, and value. Both simple and compound filtering is available. The format is `filters={field_01}:{op}:{value},{field_02}:{op}:{value}`.
- `page` 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 `page` as the `nextPage` or `prevPage` value for navigation.

## Headers

- `sessionId` string, nullable — API session ID generated with `/v3/partner/login`
- `appKey` string, nullable — Application key sent to you by BILL when you create a partner account
- `organizationId` string, nullable — BILL-generated ID of the organization

## Response `200`

Get list of users response

- ListUserResponseDto — Response from a list API request with paging references.
  - `nextPage` string
  - `prevPage` string
  - `results` OrganizationUserResponseDto[]
    - `id` string — BILL-generated ID of the user. The value begins with `006`.
    - `archived` boolean — Set as `true` if the user is archived
    - `firstName` string — User first name
    - `lastName` string — User last name
    - `email` string — User email address
    - `role` object — User role information
      - `id` string — BILL-generated ID of the user role. The value begins with `0po`.
      - `type` 'ADMINISTRATOR' | 'CLERK' | 'APPROVER' | 'ACCOUNTANT' | 'CUSTOM' | 'PAYER' | 'PARTNER' | 'AUDITOR' | 'NO_ACCESS' | 'MEMBER' | 'MEMBER_PLUS' | 'INTERNAL' | 'PURCHASE_REQUESTER' | 'CONSOLE_CUSTOM' | 'RECEIVER' | 'PROCUREMENT_USER' | 'UNDEFINED' — User role type.
      - `description` string — User role description
    - `createdTime` string, date-time — Created date and time
    - `updatedTime` string, date-time — Updated 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/versions/0483350c434e/schema)