Groups API (1.0.0)

Download OpenAPI specification:

API documentation for retrieving group lists and detailed group information.

Groups

Returns list of groups that current user can manage

Returns list of groups that current user can manage.

Required Permissions:

GROUP_OWNER role

Authorizations:

BearerAuth

Responses

Response samples

200

Content type

application/json

[{"id": 19578,
"name": "Acme Corp",
"isParent": true,
"parentGroupId": 0,
"isDefault": true
},
{"id": 19580,
"name": "Acme Sub",
"isParent": false,
"parentGroupId": 19578,
"isDefault": false
}
]

Get detailed information for a specific group

Returns detailed information for a specific group including:

Group ID
Group name
Default base address
Default subscription plan ID
Default billing info ID

Users can only access details for their own group.

Required Permissions:

GROUP_OWNER role

Additional Authorization:

User must belong to the requested group (returns 403 if accessing a different group)

Authorizations:

BearerAuth

path Parameters

group_id

required

integer <uint32>

The group ID to retrieve details for

Responses

Response samples

200

Content type

application/json

{"groupId": 19578,
"groupName": "Acme Corp",
"defaultBaseAddress": "acme",
"defaultPlanId": 5,
"defaultBillingInfoId": 100
}