Skip to main content
GET
List customer groups
The group Name and a detail Name are the Group and GroupDetail of group memberships.
When creating a customer, at least one detail from every group with IsMandatory: true must be sent in GroupMembers. Otherwise code 1605 is returned.

Error codes

This endpoint has no endpoint-specific error codes. The general errors that apply to every endpoint (authentication, permissions, request headers, request limits) still apply.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional; if sent, it is written to created records.

Required range: x >= 1

Response

OK

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
null | object[]
required

Response data. Null when Success is false.

Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.