curl --request GET \
--url https://{host}/cleemy-procurement/api/suppliers \
--header 'Authorization: <authorization>'{
"items": [
{
"id": 123,
"name": "<string>",
"state": "Active",
"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,
"unit": "Day"
},
"bankAccount": {
"iban": "<string>",
"bic": "<string>"
},
"preferredNature": {
"id": 123,
"name": "<string>",
"href": "<string>"
},
"preferredPaymentMethod": "BankTransfer",
"preferredCostCenter": {
"id": 123,
"name": "<string>",
"code": "<string>",
"href": "<string>"
},
"establishments": [
{
"id": 123,
"name": "<string>",
"href": "<string>"
}
],
"flag": "Unflagged"
}
],
"prev": "<string>",
"next": "<string>",
"count": 1
}List suppliers.
curl --request GET \
--url https://{host}/cleemy-procurement/api/suppliers \
--header 'Authorization: <authorization>'{
"items": [
{
"id": 123,
"name": "<string>",
"state": "Active",
"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,
"unit": "Day"
},
"bankAccount": {
"iban": "<string>",
"bic": "<string>"
},
"preferredNature": {
"id": 123,
"name": "<string>",
"href": "<string>"
},
"preferredPaymentMethod": "BankTransfer",
"preferredCostCenter": {
"id": 123,
"name": "<string>",
"code": "<string>",
"href": "<string>"
},
"establishments": [
{
"id": 123,
"name": "<string>",
"href": "<string>"
}
],
"flag": "Unflagged"
}
],
"prev": "<string>",
"next": "<string>",
"count": 1
}API key. Value must be formatted like so: lucca application={api_key}.
Filter on supplier state.
Active, Archived Full-text search on supplier name.
Include root collection fields (paging).
prev, next, count Page selection. Page tokens can be retrieved by adding ?fields.root=next,prev on your GET collections requests.
Page size.
0 <= x <= 1000Was this page helpful?