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" : String, "externalIdSource" : 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 638709db-0aeb-4c6d-8108-c3e47190ba86

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-08-21T15:02:25.305831Z", "users": [] }, { "id": 2, "organizationId": 1, "name": "Group2", "description": "", "dateCreated": "2026-08-21T15:02:25.309765Z", "users": [] }, { "id": 3, "organizationId": 1, "name": "Group3", "description": "", "dateCreated": "2026-08-21T15:02:25.312125Z", "users": [] }]

Example: Get all user groups by search

GET/v1/user-groups

parameter	search	group1
parameter	offset	0
parameter	size	4
header	Authorization	Bearer 50f5a262-3ff6-4d9d-8c1a-1039dd870fe6

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-08-21T15:02:26.506872Z", "users": [] }]

Example: Get all user groups with users

GET/v1/user-groups

parameter	offset	0
parameter	size	4
parameter	includeUsers	true
header	Authorization	Bearer 93cf02c1-45cf-421e-ae31-e6f0310e99a7

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-08-21T15:02:27.703474Z", "users": [] }, { "id": 2, "organizationId": 1, "name": "Group2", "description": "", "dateCreated": "2026-08-21T15:02:27.705463Z", "users": [{ "id": 1, "account": { "id": 1 }, "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": true, "groupAdmin": false, "dateCreated": "2026-08-21T15:02:27.700999Z" }] }, { "id": 3, "organizationId": 1, "name": "Group3", "description": "", "dateCreated": "2026-08-21T15:02:27.707397Z", "users": [{ "id": 1, "account": { "id": 1 }, "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": true, "groupAdmin": false, "dateCreated": "2026-08-21T15:02:27.700999Z" }] }]

Example: Get all user groups for specific user

GET/v1/user-groups

parameter	offset	0
parameter	size	3
parameter	userId	1
header	Authorization	Bearer 3ebfd5c6-5df6-4c8a-b416-89abd5941f98

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": 2, "organizationId": 1, "name": "Group2", "description": "", "dateCreated": "2026-08-21T15:02:28.900522Z", "users": [] }, { "id": 3, "organizationId": 1, "name": "Group3", "description": "", "dateCreated": "2026-08-21T15:02:28.902568Z", "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 13da59db-4d21-467b-a1aa-8564523842d3

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": 3, "organizationId": 1, "name": "Group3", "description": "", "dateCreated": "2026-08-21T15:02:30.147897Z", "users": [] }, { "id": 2, "organizationId": 1, "name": "Group2", "description": "", "dateCreated": "2026-08-21T15:02:30.146108Z", "users": [] }, { "id": 1, "organizationId": 1, "name": "Group1", "description": "", "dateCreated": "2026-08-21T15:02:30.144136Z", "users": [] }]