LogoLogo
Go to WebsiteLoginGet a Demo
  • Introduction
  • Getting Started
  • Authentication
  • Users
    • GET /users
    • GET /users/{id}
  • User Groups
    • GET /UsersGroups/
    • GET /UsersGroups/{usersGroupId}
    • GET /UsersGroups/{usersGroupId}/DefaultWorkApps
    • GET /UsersGroups/{usersGroupId}/HiddenWorkApps
    • GET /UsersGroups/{usersGroupId}/Users
    • POST /UsersGroups/{usersGroupId}/Users
    • DELETE /UsersGroups/{usersGroupId}/Users/{userId}
  • Applications
    • GET /WorkApps
    • GET /WorkApps/{workAppId}
    • GET /WorkApps/{workAppId}/Accesses
    • GET /WorkApps/{workAppId}/PermissionLevels
    • POST /WorkApps/Accesses
    • PUT /WorkApps/{workAppId}/Policies/{requestType}
    • PUT /WorkApps/{workAppId}/PermissionLevels/{permissionLevelId}/Policies/{requestType}
  • Tasks
    • GET /Tasks/{taskId}
    • POST /Tasks/{taskId}/Approve
    • POST /Tasks/{taskId}/Decline
  • Policies
    • GET /Policies/CompatiblePolicies/{requestType}
  • Webhooks
    • Webhook’s signature verification
  • Changelog
Powered by GitBook

Links

  • Privacy policy
  • Imprint
  • Support

© All right reserved, Cakewalk Technology GmbH 2025

On this page

Was this helpful?

  1. User Groups

GET /UsersGroups/{usersGroupId}

PreviousGET /UsersGroups/NextGET /UsersGroups/{usersGroupId}/DefaultWorkApps

Last updated 16 days ago

Was this helpful?

Retrieves detailed information for a specific users group.

get
Authorizations
Path parameters
usersGroupIdstring · uuidRequired

The unique identifier of the users group.

Header parameters
X-API-SECRETstringRequired

API Secret is used to verify the integrity of the request and authenticate the client. It should be included in all requests. This value must be kept confidential and should never be exposed in client-side code or public repositories.

Example: YOUR_API_SECRET
Responses
200
OK
401
Unauthorized
404
Not Found
500
Internal Server Error
get
GET /api/v1/UsersGroups/{usersGroupId} HTTP/1.1
Host: open-api.getcakewalk.io
X-API-KEY: YOUR_API_KEY
X-API-SECRET: YOUR_API_SECRET
Accept: */*
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "isIdpGroup": true,
    "description": "text",
    "numberOfUsers": 1,
    "numberOfDefaultWorkApps": 1,
    "numberOfHiddenWorkApps": 1
  },
  "links": {
    "self": "text",
    "next": "text"
  }
}