List Contacts
GET /contacts
Returns all buyer contacts for your company. Requires the contact:read scope. Supports filtering by name, VAT number, or electronic address.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Search by name, VAT number, or electronic address.
Responses
Section titled “ Responses ”List of contacts.
object
object
Unique contact identifier (UUID).
Display name of the buyer.
Buyer’s electronic address (e.g. Peppol ID like 0208:LU12345678).
Scheme identifier for the electronic address (e.g. 0208, 0088).
Buyer’s VAT registration number.
Structured buyer data matching the UBL buyer schema.
object
Buyer’s display name.
Buyer’s registered legal name.
Buyer’s trading name (if different from legal name).
Buyer’s electronic address for Peppol delivery.
object
Scheme identifier (e.g. 0208, 0088, 9925).
Electronic address value (e.g. LU12345678).
Additional buyer identifiers.
Company registration identifier.
object
Registration scheme (e.g. 0002 for SIREN).
Registration number.
Buyer’s VAT registration number.
Tax registration identifier (for non-VAT tax schemes).
object
Tax scheme identifier.
Tax registration number.
Buyer’s postal address.
object
Street name and number.
Additional street line.
Third address line.
City or town name.
State, province, or region.
Postal or ZIP code.
ISO 3166-1 alpha-2 country code (e.g. LU, DE, FR).
Buyer’s contact person details.
object
Contact person name.
Contact phone number.
Contact email address.
Per-contact invoicing defaults applied when the contact is picked on an invoice.
object
Days between issue date and due date.
Default invoice currency (ISO 4217).
Language used for the invoice PDF and email (ISO 639-1).
Note prefilled on new invoices for this contact.
Business entity that usually invoices this contact.
Delivery network normally used for this contact.
Branding profile stamped onto new invoices for this contact; null uses the company default.
Contact persons at the buyer; the default one is snapshotted onto invoices.
object
Unique person identifier (UUID).
Person’s full name.
Person’s role at the buyer.
Person’s email address.
Person’s phone number.
Whether this person is used on invoices and for delivery.
Number of invoices issued to this contact.
Result of the last Peppol reachability check (null if never checked).
ISO 8601 timestamp of the last reachability check.
Whether the stored reachability result is older than 30 days.
Document types the buyer accepts on Peppol, as of the last check.
ISO 8601 timestamp when the contact was created.
ISO 8601 timestamp when the contact was last updated.