GET/v1/user-groupsGet users groups

Get users groups description

parameter	includeUsers	The connected users will be returned directly: Boolean
parameter	search	Wildcard searching user groups by name: String
parameter	organizationId	Organization filter: Number
parameter	sortBy	Sort by: name: String
parameter	sortDirection	Sort direction: asc, desc: "Asc" / "Desc"
parameter	offset	Page offset (default: 0): Number
parameter	size	Number of items on Page (default: 50, max: 100): Number
header	Authorization	Authentication token (bearer token or API key).

Response

status	200	All ok, returned found users groups
status	401	Invalid authentication token
status	403	Insufficient rights
[{ "id" : Number, "organizationId" : Number, "name" : String, "description" : String, "remarks" : String, "dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"), "dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"), "externalId" : { "value" : String }, "users" : [{ "id" : Number, "account" : { "id" : Number, "firstName" : String, "lastName" : String }, "firstName" : String, "lastName" : String, "emailAddress" : String, "emailAddressVerify" : Boolean, "emailAddressVerified" : Boolean, "phoneNumber" : Phone number (E.164, e.g. "+31850607337"), "phoneNumberVerify" : Boolean, "phoneNumberVerified" : Boolean, "superUser" : Boolean, "groupAdmin" : Boolean, "description" : String, "remarks" : String, "dateModified" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"), "dateCreated" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"), "externalId" : String, "autoRemoveAfter" : "WEEK" / "MONTH" / "YEAR", "autoRemoveDate" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00") }] }]

Example: Get all user groups without users

GET/v1/user-groups

parameter	offset	0
parameter	size	4
header	Authorization	Bearer f66e3188-f291-4ad4-8a1e-62d6bb07c380

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
[{ "id": 1, "organizationId": 1, "name": "Group1", "description": "", "dateCreated": "2026-03-10T09:32:05.598979Z", "users": [] }, { "id": 2, "organizationId": 1, "name": "Group2", "description": "", "dateCreated": "2026-03-10T09:32:05.600065Z", "users": [] }, { "id": 3, "organizationId": 1, "name": "Group3", "description": "", "dateCreated": "2026-03-10T09:32:05.600786Z", "users": [] }]

Example: Get all user groups by search

GET/v1/user-groups

parameter	search	group1
parameter	offset	0
parameter	size	4
header	Authorization	Bearer 582b8ebd-c6d9-436f-b468-e752283ea8c2

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
[{ "id": 4, "organizationId": 2, "name": "Group1", "description": "", "dateCreated": "2026-03-10T09:32:06.315741Z", "users": [] }]

Example: Get all user groups with users

GET/v1/user-groups

parameter	offset	0
parameter	size	4
parameter	includeUsers	true
header	Authorization	Bearer 7c58cf8a-c86b-4675-ad8c-81ab644de269

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
[{ "id": 7, "organizationId": 3, "name": "Group1", "description": "", "dateCreated": "2026-03-10T09:32:07.03552Z", "users": [] }, { "id": 8, "organizationId": 3, "name": "Group2", "description": "", "dateCreated": "2026-03-10T09:32:07.036108Z", "users": [{ "id": 3, "account": { "id": 4 }, "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": true, "groupAdmin": false, "dateCreated": "2026-03-10T09:32:07.034127Z" }] }, { "id": 9, "organizationId": 3, "name": "Group3", "description": "", "dateCreated": "2026-03-10T09:32:07.036549Z", "users": [{ "id": 3, "account": { "id": 4 }, "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": true, "groupAdmin": false, "dateCreated": "2026-03-10T09:32:07.034127Z" }] }]

Example: Get all user groups for specific user

GET/v1/user-groups

parameter	offset	0
parameter	size	3
parameter	userId	4
header	Authorization	Bearer 299a8674-f174-4346-bcf6-b5823a1df1ed

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
[{ "id": 11, "organizationId": 4, "name": "Group2", "description": "", "dateCreated": "2026-03-10T09:32:07.773334Z", "users": [] }, { "id": 12, "organizationId": 4, "name": "Group3", "description": "", "dateCreated": "2026-03-10T09:32:07.773793Z", "users": [] }]

Example: Get all user groups sorted

GET/v1/user-groups

parameter	offset	0
parameter	size	4
parameter	sortBy	name
parameter	sortDirection	desc
header	Authorization	Bearer 12412d40-de5d-40df-86c1-117a7467c2c1

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
[{ "id": 15, "organizationId": 5, "name": "Group3", "description": "", "dateCreated": "2026-03-10T09:32:08.460016Z", "users": [] }, { "id": 14, "organizationId": 5, "name": "Group2", "description": "", "dateCreated": "2026-03-10T09:32:08.459259Z", "users": [] }, { "id": 13, "organizationId": 5, "name": "Group1", "description": "", "dateCreated": "2026-03-10T09:32:08.458453Z", "users": [] }]