Пространства

Заметки
Экспертный уровень
Ключ API должен быть отправлен как токен Bearer в заголовке Authorization запроса. Получите ваш API-ключ.
Список

API-эндпоинт:

GET 
https://yoopage.ru/api/v1/spaces

Пример запроса: 

curl --location --request GET 'https://yoopage.ru/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
необязательный string
Поисковый запрос.
search_by
необязательный string
Поиск по. Возможные значения: name для Имя. По умолчанию: name.
sort_by
необязательный string
Сортировать по. Возможные значения: id для Дата создания, name для Имя. По умолчанию: id.
sort
необязательный string
Сортировка. Возможные значения: desc для По убыванию, asc для По возрастанию. По умолчанию: desc.
per_page
необязательный int
Результатов на страницу. Возможные значения: 10, 25, 50, 100. По умолчанию: 10.
Показать

API-эндпоинт:

GET 
https://yoopage.ru/api/v1/spaces/{id}

Пример запроса: 

curl --location --request GET 'https://yoopage.ru/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Сохранить

API-эндпоинт:

POST 
https://yoopage.ru/api/v1/spaces

Пример запроса: 

curl --location --request POST 'https://yoopage.ru/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Параметр
Тип
Описание
name
обязательный string
Название пространства.
color
необязательный integer
Цветовой код. Возможные значения: 1, 2, 3, 4, 5, 6. По умолчанию: 1.
Обновить

API-эндпоинт:

PUT PATCH 
https://yoopage.ru/api/v1/spaces/{id}

Пример запроса: 

curl --location --request PUT 'https://yoopage.ru/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
name
необязательный string
Название пространства.
color
необязательный integer
Цветовой код. Возможные значения: 1, 2, 3, 4, 5, 6.
Удалить

API-эндпоинт:

DELETE 
https://yoopage.ru/api/v1/spaces/{id}

Пример запроса: 

curl --location --request DELETE 'https://yoopage.ru/api/v1/spaces/{id}' \
--header 'Authorization: Bearer {api_key}'