List Groups

This API returns a list of groups available within the tenant.

Endpoint Details

URL	/v1/auth/groups
Method	GET
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Response

Here is an example of a response when viewing a list of data:

Response

{
    "groups": [
        {
            "id": "8c9258f8-14c9-42c5-978b-f7a652c13444",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Grup Jeje 2",
            "description": "deskripsi grup",
            "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_at": 1784085688,
            "updated_at": 1784085688,
            "member_count": 1
        },
        {
            "id": "c10ac748-6218-4bd6-9ca0-97ea933da3d6",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Grup Jeje 1",
            "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_at": 1784085536,
            "updated_at": 1784085536,
            "member_count": 1
        },
        {
            "id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Group Jeje",
            "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_at": 1781757473,
            "updated_at": 1781757473,
            "member_count": 3
        },
        {
            "id": "5ff4e1da-3d8d-4fde-9d01-52bde2b3bd3f",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Group Taka",
            "created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "updated_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
            "created_at": 1778763626,
            "updated_at": 1778763626,
            "member_count": 3
        }
    ],
    "pagination": {
        "total": 4,
        "page": 1,
        "page_size": 4,
        "last_page": 1
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the group
tenant_id	UUID	Identifier of the tenant that owns the group
name	String	Name of the group
description	String	Description of the group
created_by	UUID	Identifier of the user who created the group
updated_by	UUID	Identifier of the user who last updated the group
created_at	Integer	Group creation timestamp in Unix format
updated_at	Integer	Last update timestamp in Unix format
member_count	Integer	Number of members in the group
total	Integer	Total number of groups available
page	Integer	Current page number
page_size	Integer	Number of records returned per page
last_page	Integer	Total number of available pages

---

info

• A valid Bearer Token is required to access this endpoint.
• The response returns all groups available within the tenant.
• The description field may not be present if the group was created without a description.
• Unix timestamp fields can be converted to a human-readable date and time format as needed.