v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Supplier

View supplier

Shows an existing supplier details

get/api/v1/suppliers/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Supplier view.

Example response

{
  "data": {
    "id": "123456789",
    "type": "Regular supplier",
    "general": {
      "honorific": "Dr.",
      "title": "CEO",
      "name": "Alice Johnson",
      "birthday": "1980-05-15",
      "address": {
        "street": "Hauptstraße 15",
        "zip": "10115",
        "city": "Berlin",
        "state": null,
        "country": "DE",
        "note": "Hauptsitz"
      }
    },
    "tags": [
      {
        "id": "tag1",
        "name": "Active",
        "color": "ff0000"
      },
      {
        "id": "tag2",
        "name": "Active",
        "color": "ff0000"
      }
    ]
  }
}