v1

latestOpenAPI 3.0.0Apache 2.02026-07-179012215.4 KB

groups

Get Groups list

Returns groups

get/api/groups

Query parameters

offsetinteger

Offset index of results for paggination purposes

limitinteger

number of results to return

sourcePartnerIdstring

return only groups created by source partner

namestring

can be used for search

Response

Groups list

idstring uuid

namestring

parentIdstring uuid nullable

Parent Groups id.

visibility'public' | 'private'

sourcePartnerIdstring

createdAtstring

updatedAtstring

deletedAtstring

Example response

[
  {
    "id": "c2eb6752-7d88-4153-93ae-fe47aee26573",
    "name": "CitizenOS members",
    "creator": {
      "id": "c2eb6752-7d88-4153-93ae-fe47aee26573"
    },
    "createdAt": "2018-08-06T04:11:41.568Z",
    "updatedAt": "2018-08-06T04:11:41.568Z",
    "deletedAt": "2018-08-06T04:11:41.568Z"
  }
]