---
title: "Return a list of all client portals"
method: GET
path: "/v1/client-portals"
tags: ["Client portal"]
---

# Return a list of all client portals

`GET /v1/client-portals`

#### See also  
Learn more about [Client portals](./client-portals-guide)

## Query parameters

- `name` string
- `status` 'offline' | 'online'
- `default_language` string
- `created_at` string — Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
- `updated_at` string — Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
- `sort` string
- `page` number
- `limit` number

## Response `200`

List of client portals in the workspace

**ℹ️ Click to see full payload**

- ClientPortalList
  - `data` ClientPortal[], required
    - `id` string, uuid, required
    - `name` string, required
    - `status` 'offline' | 'online', required
    - `default_language` 'en' | 'fr' | 'it' | 'de' | 'es' | 'nl' | 'pt' | 'pl' | 'hu' | 'ja' | 'ko', required
    - `url` string, required
    - `updated_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
    - `created_at` string, date-time, required — Creation date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
  - `pagination` Pagination, required
    - `page` number, required — Current page number (defined in query parameter)
    - `limit` number, required — Item count per page (defined in query parameter)
    - `count` number, required — Total items count

## Other responses

- `400` — The request is either malformed or contain invalid parameters. - One or multiple filtering parameters might be malformed. Make sure to use a supported operator and value for each filter. - If specified, make sure the value of the `page` or `limit` query parameter are valid. - Value of the `sort` parameter is invalid. Make sure the field name is supported, the sorting order is correctly specified, and a same field is not used multiple times for sorting.

---

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