> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get User Group List > Gets an array of UserGroup objects. NsApiSlow threshold: 1000 ms. ## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps. ## OpenAPI ````yaml /openapi/agent/openapi-v3-UserAgent.json post /api/v1/Agents/User/GetUserGroupList openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - UserAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/User/GetUserGroupList: post: tags: - User_Agent summary: Get User Group List description: "Gets an array of UserGroup objects.\n\nNsApiSlow threshold: 1000 ms.\r\n## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps." operationId: v1UserAgent_GetUserGroupList parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: type: array items: format: int32 type: integer text/json: schema: type: array items: format: int32 type: integer application/xml: schema: type: array items: format: int32 type: integer text/xml: schema: type: array items: format: int32 type: integer application/x-www-form-urlencoded: schema: type: array items: format: int32 type: integer application/json-patch+json: schema: type: array items: format: int32 type: integer application/merge-patch+json: schema: type: array items: format: int32 type: integer description: The identifiers of the UserGroup object required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.UserGroup' text/json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.UserGroup' application/xml: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.UserGroup' text/xml: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.UserGroup' application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.UserGroup' application/merge-patch+json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.UserGroup' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.CRM.Services.UserGroup: description: "The main user group that this user belongs to\r\n\r\nCarrier object for UserGroup.\r\nServices for the UserGroup Carrier is available from the User Agent." type: object properties: Value: description: UserGroup name type: string Tooltip: description: Tooltip or other description type: string Id: format: int32 description: Primary key type: integer Rank: format: int32 description: Rank order type: integer Deleted: description: >- Deleted equal to true means that this is a user group that no longer can be selected by the user. It is not permitted to delete a UserGroup. type: boolean TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [Get User Group](/en/api/reference/restful/rest/list_usergroup/get-user-group.md) - [Get All User Group](/en/api/reference/restful/rest/list_usergroup/get-all-user-group.md) - [Get User Group Headings](/en/api/reference/restful/rest/list_usergroup/get-user-group-headings.md) - [Get Visible For User Groups](/en/api/reference/restful/rest/list_item/get-visible-for-user-groups.md) - [Get List Items For User Group](/en/api/reference/restful/agent/list_agent/get-list-items-for-user-group.md)