Skip to main content

Detail Group by ID

This API returns detailed information about a specific group identified by ID.

Endpoint Details

URL/v1/auth/groups/id
MethodGET
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To retrieve the details of a specific group, use the following request format:

/v1/auth/groups/81ad4d05-d11a-4809-b1f2-cc000c086730

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the group

Response

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

Response
{
"group": {
"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
}
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the group
tenant_idUUIDIdentifier of the tenant that owns the group
nameStringName of the group
descriptionStringDescription of the group
created_byUUIDIdentifier of the user who created the group
updated_byUUIDIdentifier of the user who last updated the group
created_atIntegerGroup creation timestamp in Unix format
updated_atIntegerLast update timestamp in Unix format
member_countIntegerNumber of members in the group

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing group.
  • 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.