GET/v1/user-groups/{id}Get a specific user group

Get a specific user group description

parameter	includeUsers	The connected users will be returned directly: Boolean
header	Authorization	Authentication token (bearer token or API key).

Response

status	200	All ok, returned found user group
status	401	Invalid authentication token
status	403	Insufficient rights
status	404	User group not found
{ "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: Returns a user group with a specific id without users

GET/v1/user-groups/1

header	Authorization	Bearer e61520c8-9e77-41cd-a8aa-fb8c3f1c0026

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:31.337307Z", "users": [] }

Example: Returns a user group with a specific id with users

GET/v1/user-groups/1

parameter	includeUsers	true
header	Authorization	Bearer 0d3b0f18-e427-43a0-91ef-1e1d0d37f4a2

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:32.533396Z", "users": [] }