List suppliers

Any signed in user. Returns a page of suppliers sorted by name, each with its contacts. Search matches name and tax number, and the list is active unless is_active is false or all.

GET/api/v1/suppliers

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Query parameters

searchstring

Free text matched against the supplier name and tax number.

is_activestring

true, false, or all. Defaults to true.

pageinteger

One based page number. Defaults to 1.

page_sizeinteger

Rows per page, capped at 200. Defaults to 20.

Responses

200

A page of suppliers

totalintegerrequired

min -9007199254740991 · max 9007199254740991

pageintegerrequired

min -9007199254740991 · max 9007199254740991

page_sizeintegerrequired

min -9007199254740991 · max 9007199254740991

itemsobject[]required

Show properties

Array of object

idstringrequired

namestringrequired

tax_numberstringrequired

contact_personstringrequired

phonestringrequired

emailstringrequired

addressstringrequired

supplier_typestringrequired

lead_time_daysintegerrequired

min -9007199254740991 · max 9007199254740991

reliability_scorenumberrequired

is_activebooleanrequired

created_atstringrequired

updated_atstringrequired

401

Not authenticated

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

searchqueryFree text matched against the supplier name and tax number.is_activequerytrue, false, or all. Defaults to true.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 20.

Request

curl -X GET 'http://localhost:8000/api/v1/suppliers' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/suppliers", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/suppliers",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "name": "string",
      "tax_number": "string",
      "contact_person": "string",
      "phone": "string",
      "email": "string",
      "address": "string",
      "supplier_type": "string",
      "lead_time_days": -9007199254740991,
      "reliability_score": 0,
      "is_active": true,
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

{
  "detail": "string"
}