Struct Docs
Struct.PIM 4
Struct.PIM 4
  • Struct PIM Documentation
  • API Reference
  • Latest updates from Struct HQ
  • Latest updates in Documentation
  • Fundamental concepts
    • Get familiar with Struct PIM
    • Catalogues & categories
    • Products & variants
    • Attributes
    • Product structures
    • Identifiers
    • Global lists
    • Localization & segmentation
    • Revisions & changelog
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Welcome to Struct PIM 4
    • Helpful guides
      • How to search efficiently
      • How to use Import
        • How to import products
        • How to import data into a list property on entities
        • How to import categories
        • How to import with media
        • How to use File templates
    • Example projects
      • Working with the API
  • Integration
    • Web API
    • Webhooks
  • Media format
  • API Reference
    • Introduction
    • Endpoints
      • AssetFolders
      • Assets
      • AssetTypes
      • AttributeGroups
      • Attributes
      • AttributeScopes
      • Browse
      • BusinessUnits
      • Catalogues
      • Categories
      • Dimensions
      • Exports
      • EnrichmentInsightSetups
      • GlobalLists
      • Languages
      • Maintenance
      • Miscellaneous
      • Messaging
      • Permissions
      • Products
      • ProductStructures
      • Publications
      • Transactions
      • UserGroup
      • UserRoles
      • Users
      • VariantGroups
      • UserTasks
      • Variants
      • Webhooks
      • Workflows
      • Models
Powered by GitBook
On this page
  1. API Reference
  2. Endpoints

UserGroup

PreviousTransactionsNextUserRoles

Endpoint for managing user groups

Returns a single usergroup from the tenant

get
Authorizations
Path parameters
uidstring · uuidRequired
Responses
200
OK
404
Not Found
get
GET /v1/usergroups/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Created": "2025-05-16T02:23:38.857Z",
  "LastModified": "2025-05-16T02:23:38.857Z",
  "CreatedBy": "text",
  "LastModifiedBy": "text",
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "Languages": [
    {
      "LanguageId": 1,
      "ReadOnly": true
    }
  ],
  "Segments": [
    {
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ],
  "BusinessUnits": [
    {
      "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ]
}

Deletes an existing usergroup

delete
Authorizations
Path parameters
uidstring · uuidRequired
Responses
200
OK
404
Not Found
delete
DELETE /v1/usergroups/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
  • GETGet all usersgroups in the tenant
  • POSTCreates a new user group
  • PUTUpdates a existing usergroup
  • GETReturns a single usergroup from the tenant
  • DELETEDeletes an existing usergroup

Get all usersgroups in the tenant

get
Authorizations
Responses
200
OK
404
Not Found
get
GET /v1/usergroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Created": "2025-05-16T02:23:38.857Z",
    "LastModified": "2025-05-16T02:23:38.857Z",
    "CreatedBy": "text",
    "LastModifiedBy": "text",
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "Languages": [
      {
        "LanguageId": 1,
        "ReadOnly": true
      }
    ],
    "Segments": [
      {
        "SegmentUid": "123e4567-e89b-12d3-a456-426614174000",
        "ReadOnly": true
      }
    ],
    "BusinessUnits": [
      {
        "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000",
        "ReadOnly": true
      }
    ]
  }
]

Creates a new user group

post
Authorizations
Body

Model for creating a user group

Uidstring · uuidOptional

Unique identifier for the user group

Namestring | nullableOptional

Name of the user group

Responses
200
OK
404
Not Found
post
POST /v1/usergroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 283

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "Languages": [
    {
      "LanguageId": 1,
      "ReadOnly": true
    }
  ],
  "Segments": [
    {
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ],
  "BusinessUnits": [
    {
      "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ]
}
No content

Updates a existing usergroup

put
Authorizations
Body

Update model for a user group

Uidstring · uuidOptional

Unique identifier for the user group

Namestring | nullableOptional

Name of the user group

Responses
200
OK
404
Not Found
put
PUT /v1/usergroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 283

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "Languages": [
    {
      "LanguageId": 1,
      "ReadOnly": true
    }
  ],
  "Segments": [
    {
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ],
  "BusinessUnits": [
    {
      "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ]
}
No content