Skip to main content
GET
Tenant credential
Required scopes: vendors.read.

Authorizations

X-API-Key
string
header
required

Tenant credential. This is sufficient by itself.

Headers

X-PrintTools-Organization-Id
string<uuid>

Tenant credential: optional and, when sent, must equal the shop bound to the key. Partner credential: required; it selects an organisation the user previously authorised.

Query Parameters

limit
integer

Requested page size. The service applies its current maximum (200); read GET /v1/reference/limits rather than hard-code it.

Required range: x >= 0
offset
integer

Zero-based row offset.

Required range: x >= 0
includeInactive
boolean

Optional includeInactive filter.

Optional search filter.

Response

Successful response.

Every 2xx response uses this envelope.

status
boolean
required

The actual resolver result. It can be false when an operation returns false or null without throwing.

message
string
required
Example:

"OK"

data
object
required

A page of vendors plus the unpaginated total (for page counts).