Sign in
Suppliers

List Suppliers

This endpoint retrieves a list of all the suppliers for the given organisation.

get/inventory/suppliers

Query parameters

idsstring uuid

A comma-separated list of supplier IDs to retrieve.

site_idstring uuid required

Filter suppliers by site.

archivedboolean

Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.

querystring

A search query to filter suppliers by. This will search the supplier name.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The suppliers were successfully retrieved

Example response

{
  "data": [
    {
      "name": "Elemis",
      "email": "orders@example.com",
      "phone": "+44 20 8012 3456",
      "address_1": "Unit E, Dominion Way",
      "address_2": "Rustington",
      "city": "Littlehampton",
      "county": "West Sussex",
      "country": "UK",
      "postcode": "BN16 3HQ"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.