Get Suppliers

get

https://public-api.spendesk.com/v1/suppliers

Allowed Scopes: supplier:read

Returns suppliers existing in the Spendesk entity (company). Supplier data is cached for 86400 seconds; supplier account data (used for accountPayable) is cached for 1200 seconds.

Pass include=externalIds to embed the IDs each supplier has in external systems (ERPs). It is opt-in because it costs one additional lookup per request.

Filter with externalIds to return only the suppliers carrying given external IDs, optionally narrowed to one provider. Suppliers with no matching mapping are excluded, so an external ID that matches nothing yields an empty page rather than every supplier.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

required

≥ 1

Defaults to 1

Page number

pageSize

integer

required

1 to 30

Defaults to 30

Page size

ids

array of strings

Supplier IDs to filter by.

ids

string

Free-text supplier search, for example by supplier name.

updatedBefore

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

updatedAfter

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

createdBefore

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

createdAfter

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

bankCountry

string

^[A-Z]{2}$

ISO alpha-2 code of the bank country

iban

string

Supplier IBAN

vatNumber

string

Supplier VAT number

isArchived

string

enum

Selects one archive state and is not additive: true returns ONLY archived suppliers, false ONLY active ones. Omit it to get both — every row carries isArchived.

Allowed:

externalIds

array of strings

length ≤ 50

Return only suppliers carrying one of these IDs in an external system (ERP). Resolved against the external-reference registry, so unmapped suppliers are excluded. Up to 50 per request.

externalIds

provider

string

length ≥ 1

Restrict the externalIds filter to one external system (e.g. Netsuite, Xero). Worth setting when a company has been connected to more than one ERP, since the same external ID string can exist in each. Ignored without that filter, and it does not narrow the externalIds include, which returns the IDs from every system (read provider on each entry).

include

array of strings

Extra data to embed in the response. externalIds costs one additional lookup per request, so it is opt-in.

include

Allowed:

sortBy

string

enum

Field to sort suppliers by.

Allowed:

sort

string

enum

Sort direction.

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response

400Bad request

401Unauthorized

403Forbidden

404Not Found

429Too Many Requests

500Internal Server Error