Skip to main content
GET
List customers
Results are returned in Data.Items. pageSize can be at most 50; larger values are treated as 50. search looks in the customer name, customer code and tax number. See Pagination and search. The list response does not include sub-records (addresses, telephones, …). Use Get customer for them.

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 for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Query Parameters

page
integer<int32>
default:1

Page number, starting from 1.

pageSize
integer<int32>
default:50

Records per page (maximum 50).

Searches in Name, CustomerCode and TaxNumber.

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
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.