Skip to content

Get Contact

GET
/contacts/{id}

Retrieve a single buyer contact by UUID. Requires the contact:read scope.

id
required
string
uuid
required
string format: uuid

The UUID of the contact.

Contact object.

object
data
required
BuyerContactResource
object
id
required

Unique contact identifier (UUID).

string
name
required

Display name of the buyer.

string
electronic_address
required

Buyer’s electronic address (e.g. Peppol ID like 0208:LU12345678).

string | null
electronic_address_scheme
required

Scheme identifier for the electronic address (e.g. 0208, 0088).

string | null
vat_number
required

Buyer’s VAT registration number.

string | null
buyer_data
required

Structured buyer data matching the UBL buyer schema.

object
name
required

Buyer’s display name.

legal_name
required

Buyer’s registered legal name.

trading_name
required

Buyer’s trading name (if different from legal name).

endpoint_id
required

Buyer’s electronic address for Peppol delivery.

object
scheme
required

Scheme identifier (e.g. 0208, 0088, 9925).

string | null
value
required

Electronic address value (e.g. LU12345678).

string | null
identifiers
required

Additional buyer identifiers.

company_id
required

Company registration identifier.

object
scheme
required

Registration scheme (e.g. 0002 for SIREN).

string | null
value
required

Registration number.

string | null
vat_number
required

Buyer’s VAT registration number.

tax_registration_id
required

Tax registration identifier (for non-VAT tax schemes).

object
scheme
required

Tax scheme identifier.

string | null
value
required

Tax registration number.

string | null
address
required

Buyer’s postal address.

object
street
required

Street name and number.

string | null
street2
required

Additional street line.

string | null
additional_line
required

Third address line.

string | null
city
required

City or town name.

string | null
subdivision
required

State, province, or region.

string | null
postal_code
required

Postal or ZIP code.

string | null
country
required

ISO 3166-1 alpha-2 country code (e.g. LU, DE, FR).

string | null
contact
required

Buyer’s contact person details.

object
name
required

Contact person name.

string | null
phone
required

Contact phone number.

string | null
email
required

Contact email address.

string | null
defaults
required

Per-contact invoicing defaults applied when the contact is picked on an invoice.

object
payment_term_days
required

Days between issue date and due date.

currency
required

Default invoice currency (ISO 4217).

language
required

Language used for the invoice PDF and email (ISO 639-1).

note
required

Note prefilled on new invoices for this contact.

seller_entity_id
required

Business entity that usually invoices this contact.

delivery_network_id
required

Delivery network normally used for this contact.

branding_profile_id
required

Branding profile stamped onto new invoices for this contact; null uses the company default.

string | null
persons
required

Contact persons at the buyer; the default one is snapshotted onto invoices.

Array<object>
object
id
required

Unique person identifier (UUID).

string
name
required

Person’s full name.

string
job_title
required

Person’s role at the buyer.

string | null
email
required

Person’s email address.

string | null
phone
required

Person’s phone number.

string | null
is_default
required

Whether this person is used on invoices and for delivery.

boolean
invoice_count

Number of invoices issued to this contact.

integer
peppol_status
required

Result of the last Peppol reachability check (null if never checked).

string | null
peppol_checked_at
required

ISO 8601 timestamp of the last reachability check.

string | null
peppol_check_stale
required

Whether the stored reachability result is older than 30 days.

boolean
peppol_document_types
required

Document types the buyer accepts on Peppol, as of the last check.

array | null
created_at
required

ISO 8601 timestamp when the contact was created.

string
updated_at
required

ISO 8601 timestamp when the contact was last updated.

string

Contact not found.

object
message
required
string
Allowed value: Contact not found.