Skip to main content
GET
/
cleemy-procurement
/
api
/
suppliers
List Suppliers
curl --request GET \
  --url https://{host}/cleemy-procurement/api/suppliers \
  --header 'Authorization: <authorization>'
import requests

url = "https://{host}/cleemy-procurement/api/suppliers"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://{host}/cleemy-procurement/api/suppliers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/cleemy-procurement/api/suppliers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://{host}/cleemy-procurement/api/suppliers"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<authorization>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{host}/cleemy-procurement/api/suppliers")
.header("Authorization", "<authorization>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{host}/cleemy-procurement/api/suppliers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "territory": {
        "id": 123,
        "name": "<string>",
        "href": "<string>"
      },
      "legalRegistration": {
        "identifier": "<string>",
        "vatNumber": "<string>"
      },
      "contacts": [
        {
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "jsmith@example.com",
          "phone": "<string>"
        }
      ],
      "paymentTerm": {
        "value": 123
      },
      "bankAccount": {
        "iban": "<string>",
        "bic": "<string>"
      },
      "preferredNature": {
        "id": 123,
        "name": "<string>",
        "href": "<string>"
      },
      "preferredCostCenter": {
        "id": 123,
        "name": "<string>",
        "code": "<string>",
        "href": "<string>"
      },
      "establishments": [
        {
          "id": 123,
          "name": "<string>",
          "href": "<string>"
        }
      ]
    }
  ],
  "prev": "<string>",
  "next": "<string>",
  "count": 1
}

Headers

Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

state
enum<string>

Filter on supplier state.

Available options:
Active,
Archived
search.terms
string

Full-text search on supplier name.

fields.root
enum<string>[]

Include root collection fields (paging).

Available options:
prev,
next,
count
page

Page selection. Page tokens can be retrieved by adding ?fields.root=next,prev on your GET collections requests.

limit
integer

Page size.

Required range: 0 <= x <= 1000

Response

200 - application/json

OK

items
supplier · object[]
required
prev
next
count
integer<int32>
Required range: x >= 0