Semaphor

Get a group

Returns full details for a group, including the shared resource count. Set includeMembers=true to also retrieve the full member list.

GET
/api/management/v1/groups/{groupId}

Authorization

BearerAuth
AuthorizationBearer <token>

A project-scoped access token. Generate one via the Token API with your project ID and project secret.

In: header

Path Parameters

groupId*string

The group's unique identifier.

Query Parameters

includeMembers?boolean

When true, include full member details in the response.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X get "https://semaphor.cloud/api/management/v1/groups/string"
{
  "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
  },
  "members": [
    {
      "id": "string",
      "groupId": "string",
      "orgUserId": "string",
      "tenantUserId": "string",
      "addedBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "orgUser": {
        "id": "string",
        "name": "string",
        "email": "user@example.com"
      },
      "tenantUser": {
        "id": "string",
        "name": "string",
        "email": "user@example.com"
      }
    }
  ],
  "sharedResources": {
    "count": 0
  }
}
{
  "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"
    }
  ]
}