Skip to main content
GET
/
api
/
v1
/
my-groups
Error
A valid request URL is required to generate request examples
{
  "hydra:member": [
    {
      "@id": "<string>",
      "@type": "<string>",
      "@context": "<string>",
      "owner": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123
      },
      "description": "<string>",
      "isProject": true,
      "hasPriority": true,
      "hasDueDate": true,
      "hasTypes": true,
      "hasStatus": true,
      "hasEvents": true,
      "hasDiscussion": true,
      "hasFiles": true,
      "isJoinable": true,
      "onlyAdminsCanPost": true,
      "onlyAdminsCanCreateEvents": true,
      "onlyAdminsCanUploadFiles": true,
      "onlyAdminsCanAddMembers": true,
      "hasGroupInfo": true,
      "includesAllMembers": true,
      "category": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "color": "<string>",
        "icon": "<string>",
        "createIsGrantedRole": "USER"
      },
      "id": 123,
      "name": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateEnded": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "unitType": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "discriminator": "<string>",
        "isLocal": true,
        "parentUnitType": "<unknown>",
        "hasUserType": true
      },
      "logo": "<string>",
      "userType": "https://example.com/",
      "isRoleGroup": true
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

​
page
integer
default:1

The collection page number

​
pagination
boolean

Enable or disable pagination

​
status
string
​
status[]
string[]
​
isJoinable
boolean
​
isJoinable[]
boolean[]
​
isRoleGroup
boolean
​
isRoleGroup[]
boolean[]
​
parent
string
​
parent[]
string[]
​
localCenter
string
​
localCenter[]
string[]
​
unitType
string
​
unitType[]
string[]
​
order[name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[parent.name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[userType.position]
enum<string>
default:asc
Available options:
asc,
desc
​
exists[isRoleGroup]
boolean
​
exists[localCenter]
boolean
​
exists[unitType]
boolean
​
exists[parent]
boolean

Response

Group collection

​
hydra:member
object[]
required
​
hydra:totalItems
integer
Required range: x >= 0
​
hydra:view
object
Example:
{
  "@id": "string",
  "type": "string",
  "hydra:first": "string",
  "hydra:last": "string",
  "hydra:previous": "string",
  "hydra:next": "string"
}
​
hydra:search
object