---
title: "List Users"
method: GET
path: "/users"
tags: ["Users"]
---

# List Users

`GET /users`

Retrieve a list of `User` resources.

## Query parameters

- `created_at.gte` string, date-time
- `created_at.lte` string, date-time
- `limit` integer
- `tags.key` string
- `tags.value` string
- `updated_at.gte` string, date-time
- `updated_at.lte` string, date-time

## Headers

- `Finix-Version` string

## Response `200`

List of `User` resources

- object
  - `page` Page — Details the page that's returned.
    - `limit` integer — The number of entries to return.
    - `next_cursor` string, nullable — The cursor to use for the next page of results.
  - `_embedded` object
    - `users` User[]
      - `id` string — The ID of the resource.
      - `created_at` string, date-time — Timestamp of when the object was created.
      - `updated_at` string, date-time — Timestamp of when the object was last updated.
      - `created_by` string — The ID of the application user that created _this_ user.
      - `email` string — The email address of the application user (max 100 characters).
      - `enabled` boolean — Whether the `User` is enabled and active. Set to `false` to disable the `User`.
      - `first_name` string, nullable — The first name of the User ID (Max 50 characters).
      - `identity` string, nullable — ID of the `Identity` that the `User` object was created under.
      - `last_name` string, nullable — The last name of the User ID (Max 50 characters).
      - `last_used_date` string, date-time — Timestamp of when the user credentials were last used to make an API call.
      - `password` string, nullable — The `password` you'll use to authetnicate requests.
      - `role` 'ROLE_PLATFORM' | 'ROLE_PARTNER' | 'ROLE_MERCHANT' — Details the level of access the [`User`](#Users) has available.
      - `tags` Tags, nullable — Include up to 50 `key: value` pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual `values` is 500. (For example, `order_number: 25`, `item_type: produce`, `department: sales`)
      - `_links` object — For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these `_links` to make your follow-up requests and quickly access relevant IDs.
        - `application` object — Link to the `Application` the resource was created under.
          - `href` string
        - `applications` object
          - `href` string
        - `self` object — Link to the resource that was used in the request.
          - `href` string
  - `_links` object
    - `self` Self — Link to the resource that was used in the request.
      - `href` string
    - `next` Next — Link to the next page of entries.
      - `href` string

## Other responses

- `401` — Unauthorized. Authentication is required and has failed or has not been provided.
- `403` — Forbidden. The client is authenticated but does not have permission to access the resource.
- `406` — Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.
- `422` — Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.

---

[API](https://skmtc.net/finix/apis/finix-api-reference.md) · [All operations](https://skmtc.net/finix/apis/finix-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/finix/finix-api-reference/versions/5426f6f99c52/schema)