Suppliers

The suppliers resource.

Basehttps://rest.carbon.ms/suppliers

GET/suppliers

List supplierss

Retrieve a paginated list of supplierss. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/suppliers

curl --request GET \
  --url 'https://rest.carbon.ms/suppliers?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "supplierTypeId": "xyz789",
    "status": "string",
    "taxId": "xyz789",
    "accountManagerId": "xyz789",
    "logo": "string",
    "assignee": "string"
  }
]

GET/suppliers

Retrieve a suppliers

Fetch a single suppliers by filtering on `id`.

Query parameters

idstring

Match on the suppliers's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/suppliers

curl --request GET \
  --url 'https://rest.carbon.ms/suppliers?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "supplierTypeId": "xyz789",
  "status": "string",
  "taxId": "xyz789",
  "accountManagerId": "xyz789",
  "logo": "string",
  "assignee": "string"
}