Read a branch

Any signed in user. Returns one branch with its address, VAT number, and trade currency. The identifier is a branch id, and an id that matches no row is refused rather than returned empty.

GET/api/v1/branches/{branchId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Path parameters

branchIdstringrequired

The branch id.

Responses

200

The branch

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

404

Branch not found

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

branchIdpath*The branch id.

Request

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

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

import requests

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

Response

{
  "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"
}

{
  "detail": "string"
}