GET/v2/usersGet users

Get a list of users based on specified parameters.

parameter	search	Wildcard searching by account/user name, phone and email: String
parameter	organizationId	Organization id filter: Number
parameter	userGroupId	UserGroup id filter: Number
parameter	accountId	Account id filter: Number
parameter	externalId	External id filter: String
parameter	client	OAuth/application client filter: String
parameter	superUser	Filter for Portal Administrators: Boolean
parameter	invitationPending	Filter if invitation is pending: Boolean
parameter	invitationExpired	Filter if invitation is expired: Boolean
parameter	includeGroups	The connected groups will be returned directly: Boolean
parameter	sortBy	Sort by: firstName, lastName: 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
status	401	Invalid authentication token
status	403	Insufficient rights
[{ "id" : Number, "account" : { "id" : Number, "firstName" : String, "lastName" : String }, "organization" : { "id" : Number, "name" : String, "personal" : Boolean, "personalAccount" : { "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, "description" : String, "remarks" : String, "invitation" : { "token" : String, UUID 4 formatted (e.g. "a426e157-8a5c-456a-8865-bec6394867ab"), "url" : String, "expiration" : Date/time with a timezone (ISO 8601, e.g. "2022-06-23T13:53:02+02:00"), "isExpired" : Boolean }, "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"), "userGroups" : [{ "id" : Number, "organizationId" : Number, "name" : String, "description" : String, "groupAdmin" : Boolean }] }]

Example: Get all organization users

GET/v2/users

parameter	organizationId	1
parameter	offset	0
parameter	size	4
header	Authorization	Bearer 3479118c-9300-426d-a815-fb1bbe40bd97

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, "account": { "id": 1, "firstName": "Anna" }, "organization": { "id": 1, "name": "Personal Account 1", "personal": true, "personalAccount": { "id": 1, "firstName": "Anna" } }, "firstName": "Annabel", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": true, "dateCreated": "2026-03-10T09:37:56.927928Z", "userGroups": [] }, { "id": 2, "organization": { "id": 1, "name": "Personal Account 1", "personal": true, "personalAccount": { "id": 1, "firstName": "Anna" } }, "firstName": "Astrid", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": false, "dateCreated": "2026-03-10T09:37:56.931202Z", "userGroups": [] }, { "id": 3, "organization": { "id": 1, "name": "Personal Account 1", "personal": true, "personalAccount": { "id": 1, "firstName": "Anna" } }, "firstName": "Beatrice", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": false, "dateCreated": "2026-03-10T09:37:56.932417Z", "userGroups": [] }]

Example: Get all organization users with sorting

GET/v2/users

parameter	organizationId	1
parameter	sortBy	firstName
parameter	sortDirection	desc
header	Authorization	Bearer f32e0240-7b32-4e9e-a229-4ac8e90c0c9b

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, "organization": { "id": 1, "name": "Personal Account 1", "personal": true, "personalAccount": { "id": 1, "firstName": "Anna" } }, "firstName": "Beatrice", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": false, "dateCreated": "2026-03-10T09:38:01.067396Z", "userGroups": [] }, { "id": 2, "organization": { "id": 1, "name": "Personal Account 1", "personal": true, "personalAccount": { "id": 1, "firstName": "Anna" } }, "firstName": "Astrid", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": false, "dateCreated": "2026-03-10T09:38:01.065991Z", "userGroups": [] }, { "id": 1, "account": { "id": 1, "firstName": "Anna" }, "organization": { "id": 1, "name": "Personal Account 1", "personal": true, "personalAccount": { "id": 1, "firstName": "Anna" } }, "firstName": "Annabel", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": true, "dateCreated": "2026-03-10T09:38:01.062771Z", "userGroups": [] }]

Example: Get all organization users by wildcard search on remarks

GET/v2/users

parameter	organizationId	1
parameter	search	interim
header	Authorization	Bearer f8812e7d-ff00-4a57-9fb4-aa037d5ef92a

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=()
[]

Example: Get users without a specified organization

GET/v2/users

header	Authorization	Bearer 98d14b1a-70c3-483a-83d7-239cefaa7ba3

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, "account": { "id": 1, "firstName": "Anna" }, "organization": { "id": 1, "name": "Personal Account 1", "personal": true, "personalAccount": { "id": 1, "firstName": "Anna" } }, "firstName": "Annabel", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": true, "dateCreated": "2026-03-10T09:38:09.354643Z", "userGroups": [] }, { "id": 4, "account": { "id": 1, "firstName": "Anna" }, "organization": { "id": 2, "name": "Business Account", "personal": false }, "firstName": "Annabel HR", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": true, "dateCreated": "2026-03-10T09:38:09.364006Z", "userGroups": [] }, { "id": 5, "organization": { "id": 2, "name": "Business Account", "personal": false }, "firstName": "Annabel HR", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": false, "dateCreated": "2026-03-10T09:38:09.365272Z", "userGroups": [] }, { "id": 2, "organization": { "id": 1, "name": "Personal Account 1", "personal": true, "personalAccount": { "id": 1, "firstName": "Anna" } }, "firstName": "Astrid", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": false, "dateCreated": "2026-03-10T09:38:09.358188Z", "userGroups": [] }, { "id": 3, "organization": { "id": 1, "name": "Personal Account 1", "personal": true, "personalAccount": { "id": 1, "firstName": "Anna" } }, "firstName": "Beatrice", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": false, "dateCreated": "2026-03-10T09:38:09.359571Z", "userGroups": [] }, { "id": 7, "account": { "id": 4, "firstName": "GroupAdmin" }, "organization": { "id": 2, "name": "Business Account", "personal": false }, "firstName": "Group Admin", "lastName": "User", "emailAddressVerify": false, "emailAddressVerified": false, "phoneNumberVerify": false, "phoneNumberVerified": false, "superUser": false, "dateCreated": "2026-03-10T09:38:09.371695Z", "userGroups": [] }]