v1

latestOpenAPI 3.1.02026-07-14159142161.9 KB
groupService

Get groups list

Get groups list

get/groups/v1/groups

Query parameters

pageinteger

current page

listnumber

how many items should be per page

archivedboolean

filter archived or non-archived group

my_groupsboolean

If true, shows only groups of my ownership or my membership

qstring

Text search pattern

Response

OK

Example response

{
  "data": [
    {
      "id": 1,
      "name": "Title group",
      "groupType": "private",
      "description": "private",
      "groupTheme": "private",
      "logo": "/8c/nsfkjnns486sd4f56.jpg",
      "moderatorsIds": [
        "11",
        "22"
      ],
      "usersIds": [
        "1",
        "2"
      ]
    }
  ],
  "meta": {
    "currentPage": 1,
    "from": 1,
    "lastPage": 1,
    "links": [
      {
        "label": "Previous"
      }
    ],
    "path": "https://domain.uspacy.ua/groups/v1/groups",
    "perPage": 20,
    "to": 2,
    "total": 2
  }
}