List branches

Any signed in user. Returns a page of branches ordered by name, with its trade currency. The list is active by default, so a closed branch comes back only when is_active is false or all.

GET/api/v1/branches

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Query parameters

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 50.

Responses

200

A page of branches

totalintegerrequired

min -9007199254740991 · max 9007199254740991

pageintegerrequired

min -9007199254740991 · max 9007199254740991

page_sizeintegerrequired

min -9007199254740991 · max 9007199254740991

itemsobject[]required

Show properties

Array of object

idstringrequired

codestringrequired

namestringrequired

citystringrequired

vat_numberstringrequired

addressstringrequired

currency_codestringrequired

image_urlstringrequired

is_activebooleanrequired

is_deletedintegerrequired

min -9007199254740991 · max 9007199254740991

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

is_activequerytrue, false, or all. Defaults to true.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 50.

Request

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

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

import requests

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

Response

{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "city": "string",
      "vat_number": "string",
      "address": "string",
      "currency_code": "string",
      "image_url": "string",
      "is_active": true,
      "is_deleted": -9007199254740991,
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

{
  "detail": "string"
}