---
title: "users"
description: "REST API endpoints for users."
canonical_url: "https://www.zeyos.com/api/users"
markdown_url: "https://www.zeyos.com/ai/guide/api/users.md"
section: "api-reference"
authority: "reference"
language: "en"
source_repository: "https://cloud.zeyos.com/__doc/openapi/api.json"
source_sha256: "f5850c6fa6f99a1b518fc8ddc4e566070b53b5506cde57a3299948d38fc6363c"
---

# ZeyOS Standard REST API (v1)

## Tag: users
Users *(restricted read-only)*

## Spec
- /__doc/openapi/api.json

## Servers
- https://cloud.zeyos.com/{INSTANCE}/api/v1 — ZeyOS Cloud

## Authentication
- oauth (oauth2) — OAuth 2.0 Authorization ([RFC 6749](https://tools.ietf.org/html/rfc6749)); use the **[ZeyOS OAuth 2.0 API](https://developers.zeyos.com/oauth2) `POST /oauth2/v1/token`** to obtain a valid bearer token
- token (http) — HTTP Bearer Authentication ([RFC 6750](https://tools.ietf.org/html/rfc6750))
- session (apiKey) — Session Cookie Authentication ([RFC 6265](https://tools.ietf.org/html/rfc6265))

## Endpoints
| Method | Path | Summary |
| ------ | ---- | ------- |
| POST | /users | List users |
| GET | /users/{ID} | Get user |
| HEAD | /users/{ID} | Check if user exists |

### POST /users
- Summary: List users
- OperationId: listUsers
- Description: List selected data from all users that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

Parameters:
- (none)

Request body:
- #/components/requestBodies/list

Responses:
- 200 — OK
  - application/json — array
- 401: #/components/responses/401
- 403: #/components/responses/403
- 500: #/components/responses/500

### GET /users/{ID}
- Summary: Get user
- OperationId: getUser
- Description: Return the data of an existing user by **`ID`**. Requires no specific permission.

Parameters:
- #/components/parameters/ID
- #/components/parameters/expand
- #/components/parameters/extdata
- #/components/parameters/tags
- #/components/parameters/If-Modified-Since
- #/components/parameters/If-None-Match

Request body:
- (none)

Responses:
- 200 — OK
  - application/json — #/components/schemas/users
- 304 — Not Modified
- 401: #/components/responses/401
- 403: #/components/responses/403
- 404 — Not Found
- 500: #/components/responses/500

### HEAD /users/{ID}
- Summary: Check if user exists
- OperationId: existsUser
- Description: Check if a user with **`ID`** exists, but do not return its data. Requires no specific permission.

Parameters:
- #/components/parameters/ID
- #/components/parameters/If-Modified-Since
- #/components/parameters/If-None-Match

Request body:
- (none)

Responses:
- 204: #/components/responses/204-exists
- 304 — Not Modified
- 401: #/components/responses/401
- 404 — Not Found
- 500: #/components/responses/500