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

# List Users

`GET /users`

List users from the Smile Network.

## Query parameters

- `size` integer
- `cursor` string
- `startDate` string, date
- `endDate` string, date

## Response `200`

OK

- UserListResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED' — Request status code
  - `message` string — Message response to the request
  - `requestId` string — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` object
    - `nextCursor` string — The next cursor value that can be used in the following query.
    - `items` User[]
      - `id` string, required — Unique ID of this object
      - `externalMetadata` ObjectExternalMetadata, required — The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters can be used - Maximum of 5 key/value pairs - Maximum key length of 50 characters - Maximum value length of 500 characters
      - `createdAt` string, date-time, required — Date and time
      - `providers` string[], required — Array of providers connected to this user (listed by provider ID)
      - `session` UserSession — User session resource
        - `userId` string, required — The user ID associated with this session
        - `channel` 'WinkSite' | 'Default' — The channel type
        - `channelId` string — The wink site ID
        - `status` 'IN_PROGRESS' | 'COMPLETED' | 'REVOKED', required — The status of a user session

## Changes

> 51 revisions in range; 2 could not be searched.

- **2026-07-15** (v1) `3bcbeecafbab` — 10 info
  - removed the non-success response with the status `400`
  - removed the non-success response with the status `401`
  - removed the non-success response with the status `403`
  - removed the non-success response with the status `404`
  - …6 more
- **2025-10-24** (v1) `2c7cb8512390` — 3 info
  - added the optional property `data/items/items/session` to the response with the `200` status
  - the `providers` response's property default value `` was added for the status `200`
  - response property `data/items/items/providers` deprecated

[Change history](https://skmtc.dev/smileapi/apis/smile-api/changes/users/get.md)

---

[API](https://skmtc.dev/smileapi/apis/smile-api.md) · [All operations](https://skmtc.dev/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smileapi/smile-api/revisions/a4930eb49f4d/schema)