Skip to main content
GET
Получить список проектов

Авторизации

Authorization
string
header
обязательно

Токен доступа, полученный через POST /auth (client_id + client_secret). Действителен в течение 300 секунд.

Заголовки

X-Sub-Account
string

Reference субсчёта, в котором должна выполняться операция. Если заголовок не передан, операция выполняется в основном аккаунте; зарезервированное значение principal также указывает на основной аккаунт и равнозначно отсутствию заголовка. Принимается всеми эндпоинтами, кроме POST /auth и самих эндпоинтов /sub-accounts, которые всегда работают с основным аккаунтом.

Возможные ошибки: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Требует, чтобы у учётных данных был включён доступ к субсчетам (Настройки → Интеграция → Учётные данные API). По умолчанию он выключен и не заменяется никаким разрешением, даже FULL_ACCESS: без него ответ — 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Пример:

"loja-centro"

Параметры запроса

page
integer
по умолчанию:1

Номер страницы

Требуемый диапазон: x >= 1
limit
integer
по умолчанию:20

Элементов на странице

Требуемый диапазон: 1 <= x <= 100
sortBy
enum<string>
по умолчанию:createdAt

Поле сортировки

Доступные опции:
createdAt,
updatedAt,
name
sortOrder
enum<string>
по умолчанию:desc

Порядок сортировки

Доступные опции:
asc,
desc

Ответ

Список проектов

items
object[]
обязательно

Список проектов

total
integer
обязательно

Общее количество проектов

Пример:

100

page
integer
обязательно

Текущая страница

Пример:

1

limit
integer
обязательно

Элементов на странице

Пример:

20

totalPages
integer
обязательно

Общее количество страниц

Пример:

5