Get User Group

Get a single user group by ID.

GEThttps://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}

Path parameters

id*string

Query parameters

Response

200404

Success

Body

application/json

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "text",
  "href": "text",
  "name": "text",
  "description": "text",
  "modules": [
    {
      "id": "text",
      "href": "text",
      "description": "text",
      "isConfigurable": false,
      "isEnabledByDefault": false,
      "paid": false,
      "name": "text",
      "accountTypes": [
        "text"
      ]
    }
  ],
  "logo": "text",
  "isDefault": false,
  "users": [
    {
      "id": "text",
      "href": "text",
      "email": "text",
      "status": "text",
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2025-01-23T20:53:26.161Z",
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "externalName": "text",
          "icon": "text",
          "technicalSupportEmail": "[e-mail]",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": [],
          "buyers": [
            {
              "id": "text",
              "href": "text",
              "icon": "text",
              "taxId": "text",
              "name": "text",
              "sellers": [
                {
                  "id": "text",
                  "href": "text",
                  "externalId": "text",
                  "icon": "text",
                  "currencies": [
                    "text"
                  ],
                  "name": "text"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}