Skip to content
Invoro Docs

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
string

Search by name, VAT number, or electronic address.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of contacts.

object
data
required
Array<object>
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
legal_name
required
trading_name
required
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
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
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
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