Skip to main content
GET
/
api
/
groups
/
cURL
curl --request GET \
  --url https://{server}/api/groups/ \
  --cookie sessionid=
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "member_count": 123
  }
]

Authorizations

​
sessionid
string
cookie
required

Query Parameters

​
member_id
string

User id or 'me'

​
name
string

Case-insensitive substring match on group name.

​
organization_id
string
​
type
string

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
organization_id
string<uuid>
required
read-only
​
name
string
required
read-only
​
description
string
required
read-only
​
type
enum<string>
required
  • members - Members
  • custom - Custom
Available options:
members,
custom
​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
member_count
integer
required
read-only