List groups
Returns groups the caller has access to. Filter by group type, tenant, or search by name. Results include each group's member count and the caller's permission flags (canEdit, canDelete, canManageMembers).
Authorization
BearerAuth AuthorizationBearer <token>
A project-scoped access token. Generate one via the Token API with your project ID and project secret.
In: header
Query Parameters
type?string
Filter by group type. Use all or omit to return both types.
Value in
"ORG_GROUP" | "TENANT_GROUP" | "all"search?string
Case-insensitive filter applied to group names.
tenantId?string
Return only tenant groups belonging to this tenant.
includeMembers?boolean
When true, include full member details in each group object.
page?integer
One-based page number.
Range
1 <= valuelimit?integer
Maximum number of groups per page (default 20, max 100).
Range
1 <= value <= 100sort?string
Sort field.
Value in
"name" | "created" | "members"order?string
Sort direction.
Value in
"asc" | "desc"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X get "https://semaphor.cloud/api/management/v1/groups"{
"groups": [
{
"id": "string",
"name": "string",
"description": "string",
"type": "ORG_GROUP",
"organizationId": "string",
"tenantId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"memberCount": 0,
"permissions": {
"canEdit": true,
"canDelete": true,
"canManageMembers": true
}
}
],
"total": 0,
"page": 0,
"limit": 0,
"hasMore": true
}{
"error": "string",
"details": "string",
"code": "string",
"fieldErrors": [
{
"field": "string",
"message": "string"
}
]
}{
"error": "string",
"details": "string",
"code": "string",
"fieldErrors": [
{
"field": "string",
"message": "string"
}
]
}{
"error": "string",
"details": "string",
"code": "string",
"fieldErrors": [
{
"field": "string",
"message": "string"
}
]
}{
"error": "string",
"details": "string",
"code": "string",
"fieldErrors": [
{
"field": "string",
"message": "string"
}
]
}