v1
latestOpenAPI 3.0.02026-07-2455104.8 MB🔒 List suppliers V3
This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.
This endpoint requires the following scopes: supplier:read.
Paginated list of suppliers.
Query parameters
The filter parameter is used to filter the results of the given endpoint.
Supported filter operators by key:
id: equals, notEquals, in, notIn
name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
number: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
email: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
street: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
zipCode: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
city: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
state: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
country: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
accountManager.id: equals, notEquals, in, notIn
groups: equals, notEquals, in, notIn
tags: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
tags.id: equals, notEquals, in, notIn
createdAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals
updatedAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals
Sort via id, -id, name, -name, number, -number, city, -city, zipCode, -zipCode, country, -country, street, -street, state, -state, createdAt, -createdAt, updatedAt and -updatedAt. Default sort is -created_at
Number of items per page. Default: 15, Max: 100
Page number.
Response
Paginated list of suppliers.
Example response
{
"data": [
{
"id": "1",
"createdAt": "2025-03-15T09:27:00+01:00",
"updatedAt": "2025-10-20T14:45:12+01:00",
"number": "800042",
"deviatingSupplierNumber": "811999",
"mainProject": {
"id": "1"
},
"primaryAddress": {
"name": "John",
"type": "mr",
"title": "Ms.",
"contactPerson": "Laura Schneider",
"department": "Research & Development",
"subDepartment": "CAI Lab",
"addressSupplement": "Gebäude B, 4. Etage",
"street": "Fuggerstraße 11",
"zipCode": "86150",
"city": "Augsburg",
"state": "BY",
"country": "DE",
"salutation": "Sehr geehrte Damen und Herren",
"gln": "1234567890123",
"email": "alice@example.com",
"phone": "+1-234-567-8900",
"fax": "+1-234-567-8901",
"mobile": "+1-234-567-8902"
},
"deviatingBillingAddress": {
"name": "John",
"type": "mr",
"title": "Ms.",
"contactPerson": "Laura Schneider",
"department": "Research & Development",
"subDepartment": "CAI Lab",
"addressSupplement": "Gebäude B, 4. Etage",
"street": "Fuggerstraße 11",
"zipCode": "86150",
"city": "Augsburg",
"state": "BY",
"country": "DE",
"salutation": "Sehr geehrte Damen und Herren",
"gln": "1234567890123",
"email": "alice@example.com",
"phone": "+1-234-567-8900",
"fax": "+1-234-567-8901",
"mobile": "+1-234-567-8902"
},
"communication": {
"language": "DE",
"website": "https://www.supplier-example.com",
"additionalContactInformation": [
{
"key": "Skype",
"value": "supplier.contact"
},
{
"key": "LinkedIn",
"value": "https://www.linkedin.com/company/supplier"
}
]
},
"financials": {
"primaryBankAccount": {
"bankName": "XYZ***",
"accountHolder": "Sup******************",
"iban": "DE89**************3000",
"bic": "*******FXXX",
"sepa": {
"isCompanySepa": true,
"mandateReference": "TN2*********************",
"mandateReferenceChange": false,
"mandateReferenceDate": "2025-03-01",
"usage": "recurring",
"isInitialMandate": true,
"remark": "Standard SEPA mandate for monthly payments"
}
},
"tax": {
"vatId": "DE112233445",
"taxNumber": "l2/345/67890",
"taxDisplay": "alwaysGross",
"taxDeterminationType": "domestic",
"customsInformation": "HS-Code 8471.30; Preferential origin: EU"
},
"paymentTerms": {
"paymentTargetDays": 30,
"paymentTargetDiscount": 2,
"paymentTargetDiscountDays": 10
},
"paymentMethod": {
"id": "1"
},
"customerNumberForSupplier": "CUST-12345",
"defaultCurrency": "EUR",
"creditLimit": 50000,
"paypal": {
"accountHolder": "Supplier Company",
"paypalAccount": "supplier@example.com",
"currency": "EUR"
}
},
"fulfillment": {
"freeShippingEnabled": false,
"freeShippingThreshold": 3.99,
"deliveryTerms": "DAP",
"deliveryBlock": false,
"deliveryBlockDate": "2025-06-10",
"deliveryBlockReason": "",
"commissionConsignmentWarehouse": {
"id": "1"
}
},
"documentDelivery": {
"preferFax": false,
"documentRecipients": {
"offer": {
"to": "offer-send@domain.tpl",
"cc": [
"offer-send-cc@otherdomain.tpl"
]
},
"creditNote": {
"to": "creditNote-send@domain.tpl",
"cc": [
"creditNote-send-cc@otherdomain.tpl"
]
},
"deliveryNote": {
"to": "deliveryNote-send@domain.tpl",
"cc": [
"deliveryNote-send-cc@otherdomain.tpl"
]
},
"purchaseOrder": {
"to": "purchaseOrder-send@domain.tpl",
"cc": [
"purchaseOrder-send-cc@otherdomain.tpl"
]
}
}
},
"supplierRoles": [
{
"project": {
"id": "1"
},
"validFrom": "2024-10-23",
"expiresAt": "2026-10-23"
},
{
"project": {
"id": "2"
},
"validFrom": "2024-11-17",
"expiresAt": "2025-11-17"
}
],
"groups": [
{
"id": "1"
},
{
"id": "2"
}
],
"accountManager": {
"id": "1"
},
"customFields": [
{
"key": "supplier_category",
"value": "Premium",
"label": "Supplier Category"
},
{
"key": "priority_level",
"value": "High",
"label": "Priority Level"
}
],
"notes": "Preferred supplier for electronic components",
"supplierPurchaseNote": "Always confirm delivery dates before ordering",
"deliveryAddresses": [
{
"id": "1",
"type": "company",
"name": "Acme Logistics Hub Berlin",
"title": "Dr.",
"contactPerson": "Marco Schmidt",
"salutation": "Hallo Logistics Team",
"department": "Logistics",
"subDepartment": "Distribution Center",
"addressSupplement": "Hall B",
"street": "Lagerweg 22",
"zipCode": "10437",
"city": "Berlin",
"state": "BE",
"country": "DE",
"gln": "4012345000300",
"phone": "+491231234567",
"mobile": "+49170123456",
"fax": "+491231234567-1",
"email": "name@provider.com",
"deliveryDetails": {
"taxType": "domestic",
"defaultDeliveryAddress": true,
"termsOfDelivery": "EXW",
"vatId": "DE123456789",
"remark": "Main Berlin hub open 06:00 to 22:00",
"note": "Deliveries after 10am only"
}
}
],
"contactPersons": [
{
"id": "17",
"type": "mr",
"name": "Alice Smith",
"title": "Ms.",
"salutation": "Dear Alice,",
"department": "Sales",
"subDepartment": "Customer Service",
"street": "123 Main St",
"addressSupplement": "Suite 100",
"zipCode": "12345",
"city": "Springfield",
"country": "US",
"state": "CA",
"phone": "+1-234-567-8900",
"mobile": "+1-800-567-8900",
"fax": "+1-234-567-8901",
"email": "alice@example.com",
"contactPersonDetails": {
"position": "Head of Controlling",
"birthday": "1978-04-12",
"language": "DE",
"allowMarketingEmails": false,
"internalNote": "Key decision‑maker for raw‑material contracts; prefers email after 17:00 CET.",
"remarks": "Speaks fluent English, French and Mandarin. Holds a PhD in Economics."
},
"groups": [
{
"id": "1"
}
],
"createdAt": "2025-03-15T09:27:00+01:00",
"updatedAt": "2025-10-20T14:45:12+01:00"
}
],
"tags": [
{
"id": "1",
"title": "important"
}
]
}
],
"meta": {
"currentPage": 1,
"from": 1,
"path": "https://api.example.com/items",
"perPage": 15,
"to": 15
},
"links": {
"first": "https://api.example.com/items?page=1",
"next": "https://api.example.com/items?page=17"
}
}