---
title: "List Client"
method: GET
path: "/v1/clients"
tags: ["Clients"]
---

# List Client

`GET /v1/clients`

List all active clients

## Query parameters

- `page_size` integer, required
- `page_number` integer, required
- `client_type` 'admin' | 'standard'

## Headers

- `Authorization` string

## Response `200`

200 response

- 200GetClients
  - `meta` object
    - `count` number — Total number of clients returned in the response.
    - `page_number` number — Current page number of the returned client list.
    - `page_size` number — Number of clients per page in the returned client list.
    - `previous_page_url` string — Previous page url in client list.
    - `next_page_url` string — Next page url in client list.
  - `clients` Client[]
    - `client_id` string — Unique identifier for the client.
    - `account_id` string — Identifier of the account to which the client belongs.
    - `name` string — Name of the client.
    - `client_owner` string — Email address of the client owner. If not specified, defaults to the account owner's email.
    - `client_type` 'admin' | 'standard' — Type of the client, either 'admin' or 'standard'.
    - `locked` boolean — Indicates whether the client is locked. If true, the client is locked; if false, it is unlocked; if null, it has not been locked.
    - `date_created` string — Date and time when the client was created.

## Other responses

- `400` — Bad Request
- `401` — Unauthorised User
- `403` — Forbidden
- `404` — The specified resource was not found
- `500` — Server Error
- `502` — Bad gateway
- `503` — Service Unavailable
- `504` — Gateway Timeout error

---

[API](https://skmtc.dev/korewireless/apis/kore-supersim.md) · [All operations](https://skmtc.dev/korewireless/apis/kore-supersim/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/korewireless/kore-supersim/revisions/b9771e13e814/schema)