Skip to main content

List all groups

Retrieve a paginated list of all groups/tribes in the domain.

Query Parameters
per_page integer

Possible values: 1 ≤ value ≤ 100

Number of results per page

page integer

Possible values: 1 ≤ value

Page number

Responses
200

successful operation

Schema OPTIONAL
data object[] OPTIONAL
uuid uuid OPTIONAL

Unique identifier for the group

name string OPTIONAL

Group's display name

about string OPTIONAL

Group description

motd string OPTIONAL

Message of the day

cluster_id uuid OPTIONAL

ID of the cluster the group is associated with

images object OPTIONAL

Group images

logo uri OPTIONAL

URL to the group's logo image

background uri OPTIONAL

URL to the group's background image

participants object OPTIONAL

Group participants information

total_count integer OPTIONAL

Total number of members in the group

members (circular)[] OPTIONAL

Members of this group

admins (circular)[] OPTIONAL

Admin members of this group

owners (circular)[] OPTIONAL

Owner members of this group

game_server object OPTIONAL

Game server information

id integer OPTIONAL

ID of the game server the group is associated with

serverlist_name string OPTIONAL

Full server name as shown in server lists

website_name string OPTIONAL

Short server name used on the website

discord_name string OPTIONAL

Server name used in Discord integrations

cluster_chat_name string OPTIONAL

Server name used in cluster chat

activity object OPTIONAL

Group activity information

status boolean OPTIONAL

Whether the group has any online members

last_active_at date-time OPTIONAL

When the group was last active

discord_connected boolean OPTIONAL

Whether the group has Discord integration set up

moderation object OPTIONAL

Moderation information

note string OPTIONAL

Administrative note about this group

created_at date-time OPTIONAL

Date and time when the group was created

links object OPTIONAL
first string OPTIONAL
last string OPTIONAL
prev string OPTIONAL
next string OPTIONAL
meta object OPTIONAL
current_page integer OPTIONAL
from integer OPTIONAL
last_page integer OPTIONAL
links object[] OPTIONAL
url string OPTIONAL
label string OPTIONAL
active boolean OPTIONAL
path string OPTIONAL
per_page integer OPTIONAL
to integer OPTIONAL
total integer OPTIONAL