Retrieve details of a specific group by its ID.
Path Parameters
The unique identifier of the group to retrieve.
Query Parameters
The organization ID that the group belongs to. Required for authorization.
Include the full list of member users in the response. When set to true, each user object in the group will be included with complete user details.
Response
The requested group object.
Unique identifier for the group.
URL-friendly identifier of the group.
Display title of the group.
ID of the organization this group belongs to.
Arbitrary metadata associated with the group as key-value pairs.
Timestamp when the group was created.
Timestamp when the group was last updated.
Total number of members in the group.
Array of user objects who are members of this group. Only included when with_members=true.
User’s unique identifier.
URL to the user’s avatar image.
User’s current state (e.g., “enabled”, “disabled”).
When the user was created.
When the user was last updated.
curl -X GET 'https://frontier.example.com/v1beta1/groups/grp_123456789?org_id=org_123' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
{
"group": {
"id": "grp_123456789",
"name": "engineering-team",
"title": "Engineering Team",
"org_id": "org_123",
"metadata": {
"department": "engineering",
"location": "us-west",
"cost_center": "1234"
},
"created_at": "2023-01-15T10:30:00Z",
"updated_at": "2023-06-20T15:45:00Z",
"members_count": 12
}
}