Skip to content

Circles API

GET /v1/me/circles

Список кіл поточного користувача.

Авторизація: Bearer <accessToken>

Відповідь 200

json
{
  "data": [
    {
      "id": "circle-uuid",
      "name": "Найближчі",
      "memberCount": 8,
      "members": [
        {
          "id": "user-uuid",
          "name": "Марія Коваль",
          "avatar": "https://cdn.pisd.uk/avatars/uuid.jpg"
        }
      ]
    }
  ]
}

TIP

members містить до 6 учасників для превью. Повний список — через GET /v1/me/circles/:id.


GET /v1/me/circles/:id

Повний список учасників кола.

Авторизація: Bearer <accessToken>

Відповідь 200

json
{
  "id": "circle-uuid",
  "name": "Найближчі",
  "memberCount": 8,
  "members": [
    {
      "id": "user-uuid",
      "name": "Марія Коваль",
      "username": "maria_koval",
      "avatar": "https://cdn.pisd.uk/avatars/uuid.jpg"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z"
}

POST /v1/me/circles

Створити нове коло.

Авторизація: Bearer <accessToken>

Тіло запиту

json
{
  "name": "Велогрупа"
}
ПолеТипОбов'язковеОпис
namestringНазва кола (2–50 символів)

Відповідь 201

json
{
  "id": "circle-uuid",
  "name": "Велогрупа",
  "memberCount": 0,
  "members": []
}

DELETE /v1/me/circles/:id

Видалити коло.

Авторизація: Bearer <accessToken>

Відповідь 200

json
{ "success": true }

POST /v1/me/circles/:id/members

Додати учасника до кола.

Авторизація: Bearer <accessToken>

Тіло запиту

json
{
  "userId": "user-uuid"
}

Відповідь 201

json
{
  "circleId": "circle-uuid",
  "user": {
    "id": "user-uuid",
    "name": "Марія Коваль",
    "avatar": "https://cdn.pisd.uk/avatars/uuid.jpg"
  }
}

Помилки

КодПричина
404Коло або користувач не знайдені
409Користувач вже у колі

DELETE /v1/me/circles/:id/members/:memberId

Видалити учасника з кола.

Авторизація: Bearer <accessToken>

Відповідь 200

json
{ "success": true }

Peaced — платформа подій