---
title: "Get Lms Users"
method: GET
path: "/api/lms/v1/users"
tags: ["Users"]
---

# Get Lms Users

`GET /api/lms/v1/users`

Returns a list of LMS User objects.

## Query parameters

- `ids` string, nullable — If provided, will only return users for these IDs.
- `remote_id` string — The third-party API ID of the matching object.
- `email_address` string — If provided, will only return users for this email address.
- `status` 'ACTIVE' | 'PENDING' | 'INACTIVE'
- `include_raw_data` boolean — Whether to include the original data Bindbee fetched from the third-party to produce these models.
- `include_custom_fields` boolean — Whether to include custom fields in the response.
- `page_size` integer — Number of results to return per page. Maximum size is 200.
- `cursor` string — The pagination cursor value.

## Headers

- `x-connector-token` string, required

## Response `200`

Successful Response

- LmsUserPaginatedResponse
  - `cursor` string, nullable, required — Cursor value to fetch next set of items
  - `page_size` integer, required — Indicates the count of items in the response
  - `items` LmsUser[], required
    - `id` string, uuid, required
    - `remote_id` string, nullable, required — The third-party API ID of the matching object.
    - `modified_at` string, required — This is the datetime that this object was last updated by Bindbee
    - `raw_data` object, nullable — This is the Raw data
    - `custom_fields` object, nullable, required — The custom fields related to the model
    - `first_name` string, nullable — The first name of the user
    - `last_name` string, nullable — The last name of the user
    - `middle_name` string, nullable — The middle name of the user
    - `email_address` string, nullable — The email address of the user
    - `phone_number` string, nullable — The phone number of the user
    - `status` 'ACTIVE' | 'PENDING' | 'INACTIVE', nullable — The status of the user. If the value is not one of the defined enum values, the original value passed through will be returned.

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/bindbee/apis/bindbee-apis.md) · [All operations](https://skmtc.net/bindbee/apis/bindbee-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bindbee/bindbee-apis/versions/7da10dc93a21/schema)