---
title: "List suppliers"
method: GET
path: "/api/v1/suppliers"
tags: ["Supplier"]
---

# List suppliers

`GET /api/v1/suppliers`

Lists existing suppliers

## Query parameters

- `filter` union
  - object
    - `id` string[]
  - object[]
    - `key` 'search' | 'id' | 'name' | 'number' | 'country' | 'zip' | 'city' | 'project' | 'projectName' | 'phone' | 'fax' | 'mobile' | 'email' | 'addressNote' | 'department' | 'subdivision' | 'vatNumber' | 'taxNumber' | 'gln' | 'tag' | 'tagName'
    - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
    - `value` union
      - string — Used for the operations 'equals', 'notEquals', 'contains', 'notContains', 'startsWith', 'endsWith' and 'is'.
      - string[] — Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.
- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.
- `order` object[]
  - `field` 'id' | 'name' | 'number' | 'country' | 'zip' | 'city' | 'project' | 'projectName' | 'telephone' | 'fax' | 'mobile' | 'email' | 'addressNote' | 'department' | 'subdivision' | 'vatNumber' | 'taxNumber' | 'gln' | 'tag' | 'tagName'
  - `dir` 'asc' | 'desc'

## Response `200`

Supplier list.

- object
  - `data` object[], required
    - `id` string, required — Resource identifier.
    - `type` string, required — The type of the supplier
    - `project` object, nullable — An optional object with id and name
      - `id` string, required — Resource identifier.
      - `name` string, required
    - `general` object, required — The general information of the supplier
      - `number` string
      - `fax` string, nullable
      - `mobile` string, nullable
      - `department` string
      - `subdivision` string
      - `vatNumber` string
      - `taxNumber` string, nullable
      - `gln` string
      - `employeeNumber` string
      - `honorific` string
      - `title` string
      - `name` string, required
      - `birthday` string, date, nullable
      - `tags` object[] — A list of tags
        - `id` string — The identifier of the tag
        - `name` string — The name of the tag
        - `color` string — Hexadecimal color value in 6-digit format without the leading # character.
      - `supplierNumber` string
      - `phone` string, nullable
      - `email` string
      - `address` object, required
        - `street` string, required
        - `zip` string, required
        - `city` string, required
        - `state` string, nullable, required
        - `country` string, required
        - `note` string, required
    - `tags` object[] — A list of tags
      - `id` string — Either ID or name and key.
      - `key` string — The key of the tag
      - `name` string — The name of the tag
      - `color` string — Hexadecimal color value in 6-digit format without the leading # character.
    - `freeFields` object[] — a list of free fields and their values
      - `id` string — Resource identifier.
      - `value` string — The value of the free field
  - `extra` object, required
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges
- `415` — Resource representation send in the request is not supported.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)