List

get

https://staging.fairmarkit.com/services/self-service/api/v3/supplier/

Returns a list of suppliers.

Query Params

limit

integer

1 to 250

Defaults to 20

Use to specify the maximum number of records to return. By default, 20 records are returned.

offset

integer

≥ 0

Defaults to 0

Use to retrieve a specific batch of records. By default, this is set to 0.

erp_system_uuid

uuid

Use to filter suppliers by ERP system UUID.

external_supplier_id

string

Use to filter suppliers by external supplier ID.

is_active

boolean

Active/Inactive status of the Supplier.

created_at_min

date-time

Lowest Supplier creating date

created_at_max

date-time

Highest Supplier creating date

updated_at_min

date-time

Lowest Supplier updating date

updated_at_max

date-time

Highest Supplier updating date

Headers

X-FM-API-KEY

string

Fairmarkit API Key

string

enum

Defaults to application/json; charset=utf-8

Generated from available response content types

Allowed:

Responses

Language

Response

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

application/json; charset=utf-8

application/json

200Successful Response

422Validation Error