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

Примечания
Уровень эксперта
Ключ API должен быть отправлен как токен Bearer в заголовке Authorization запроса. Получите ключ API.
Список

Конечная точка API:

GET
https://goo.vc/api/v1/spaces?ru

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

curl --location --request GET 'https://goo.vc/api/v1/spaces?ru' \
--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
дополнительно integer
Результаты на странице. Возможные значения: 10, 25, 50, 100. По умолчанию: 10.
Показать

Конечная точка API:

GET
https://goo.vc/api/v1/spaces/{id}?ru

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

curl --location --request GET 'https://goo.vc/api/v1/spaces/{id}?ru' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Магазин

Конечная точка API:

POST
https://goo.vc/api/v1/spaces?ru

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

curl --location --request POST 'https://goo.vc/api/v1/spaces?ru' \
--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://goo.vc/api/v1/spaces/{id}?ru

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

curl --location --request PUT 'https://goo.vc/api/v1/spaces/{id}?ru' \
--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://goo.vc/api/v1/spaces/{id}?ru

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

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