User groups

Create group

Creates a new group. Returns the created Group object.

• POST
• /orgstruct/groups

Request body:

Attribute	Type	Description	Nullable
externalId	String	Group external id	true
name	String	Name of the group	false
description	String	Description	true
blockWebAccess	Boolean	Blocks access to the web interface for all users of the group	false
active	Boolean	Whether the group is active. Default true	true
userIds	List of integers	Identifiers of users to add to the group	true
roles	List objects	Roles granted to every member of the group, as a list of {name, description} objects	true

Examples

curl --request POST https://api.qvalon.com/v1/orgstruct/groups \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"name":"Store Managers","description":"All store managers","blockWebAccess":false,"active":true,"userIds":[1609],"roles":[]}'

200 OK

{

"id": 301,

"name": "Store Managers",

"description": "All store managers",

"blockWebAccess": false,

"active": true

}

Update group

Updates an existing group by id. Returns the updated Group object.
Both userIds and roles must be present in the body (use an empty array if there's nothing to set) — omitting either one causes a 500 Internal Server Error.

• PUT
• /orgstruct/groups/{id}

Request body:

Attribute	Type	Description	Nullable
externalId	String	Group external id	true
name	String	Name of the group	false
description	String	Description	true
blockWebAccess	Boolean	Blocks access to the web interface for all users of the group	false
active	Boolean	Whether the group is active	true
userIds	List of integers	Identifiers of users in the group. Required — pass an empty array to keep the group empty	false
roles	List objects	Roles granted to every member of the group, as a list of {name, description} objects. Required — pass an empty array for none	false

Examples

curl --request PUT https://api.qvalon.com/v1/orgstruct/groups/301 \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"name":"Store Managers","description":"All store managers, updated","blockWebAccess":false,"active":true,"userIds":[1609],"roles":[]}'

200 OK

{

"id": 301,

"name": "Store Managers",

"description": "All store managers, updated",

"blockWebAccess": false,

"active": true

}

List groups

Returns a list of Group objects

• GET
• /orgstruct/groups

Request parameters:

Request Parameter	Type	Description	Required
name	String	Find group by name	false
ids	List of integers	Find groups by ids	false
fields	List of string	Additional group fields to include in the response object. Available values: roles, users	false
userId	Integer	Find groups the given user belongs to	false
skipUserId	Integer	Find groups the given user does NOT belong to	false
businessDirIds	List of integers (comma-separated)	Find groups by business direction ids	false
onlyActive	Boolean	Get only active groups. Default true	false

Examples

curl https://api.qvalon.com/v1/orgstruct/groups?onlyActive=false \

--header 'Authorization: Bearer <your_token>'

200 OK

[

{

"id": 301,

"name": "Store Managers",

"blockWebAccess": false,

"active": true

},

{

"id": 302,

"name": "Store Employees",

"blockWebAccess": false,

"active": true

}

]

Get user groups

Returns a list of Group objects the given user belongs to.

• GET
• /orgstruct/users/{id}/groups

Examples

curl https://api.qvalon.com/v1/orgstruct/users/1609/groups \

--header 'Authorization: Bearer <your_token>'

200 OK

[

{

"id": 301,

"name": "Store Managers",

"blockWebAccess": false,

"active": true

}

]

Get groups available to user

Returns a list of Group objects the given user does not currently belong to — useful for building an "add to group" picker.

• GET
• /orgstruct/users/{id}/groups/available

Examples

curl https://api.qvalon.com/v1/orgstruct/users/1609/groups/available \

--header 'Authorization: Bearer <your_token>'

200 OK

[

{

"id": 302,

"name": "Store Employees",

"blockWebAccess": false,

"active": true

},

{

"id": 303,

"name": "Office workers",

"blockWebAccess": false,

"active": true

}

]

Add user to groups

Adds the user to the given groups, in addition to the groups they already belong to.

• POST
• /orgstruct/users/{id}/groups/{groupIds}

Examples

curl --request POST https://api.qvalon.com/v1/orgstruct/users/id}/groups/{groupIds \

--header 'Authorization: Bearer <your_token>'

200 OK

{}

Replace user groups

Replaces the user's groups with the given ones — groups not in the list are removed.

• PUT
• /orgstruct/users/{id}/groups/{groupIds}

Examples

curl --request PUT https://api.qvalon.com/v1/orgstruct/users/id}/groups/{groupIds \

--header 'Authorization: Bearer <your_token>'

200 OK

{}

Remove groups from user

Removes the given groups from the user; other groups the user belongs to are left as is.

• DELETE
• /orgstruct/users/{id}/groups/{groupIds}

Examples

curl --request DELETE https://api.qvalon.com/v1/orgstruct/users/id}/groups/{groupIds \

--header 'Authorization: Bearer <your_token>'

200 OK

{}

Remove all groups from user

Removes the user from all groups they belong to.

• DELETE
• /orgstruct/users/{id}/groups

Examples

curl --request DELETE https://api.qvalon.com/v1/orgstruct/users/1609/groups \

--header 'Authorization: Bearer <your_token>'

200 OK

{}