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 finds customers whose name contains the text, or whose customer code, tax number or one of whose e-mail addresses (links of the e-mail type) is exactly the text. See Pagination and search. Each customer is returned with its e-mail addresses (Emails, links of the e-mail type), telephone numbers (Telephones) and group memberships (GroupMembers). Other sub-records (addresses, representatives, bank accounts, …) are not included in the list; use Get customer for them.

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

Query Parameters

page
integer<int32>
default:1

Page number, starting from 1.

pageSize
integer<int32>
default:50

Records per page (maximum 50).

Contains search in Name; exact match on CustomerCode, TaxNumber and the customer's e-mail links.

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.