Skip to main content
GET
List supplier facilities in the buyer's network

Authorizations

X-API-KEY
string
header
required
OW-KEY
string
header
required

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Query Parameters

offset
integer

Number of records to skip.

Required range: x >= 0
limit
integer
default:10

Page size. Default 10, maximum 25.

Required range: 1 <= x <= 25
sort_by
string

Field/column to sort by.

order
enum<string>

Sort direction.

Available options:
asc,
desc

Matches facility name, display name, or the buyer's alias for the facility.

name
string
status
string
problemTypeId
integer
spendCategoryId
integer
locationId
integer

Response

Success.

type
string
required

Entity type marker, e.g. "SupplierFacility".

data
object[]
required
count
integer
required

Total number of matching records (not just this page).

status
enum<string>
required
Available options:
ok