List Relations
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Max items returned (1–100).
1 <= x <= 100Number of items to skip (pagination). Capped at 10000.
0 <= x <= 10000Filter by relation type: company or contact.
Filter companies that are (not) customers. Excludes contacts.
Filter companies that are (not) suppliers. Excludes contacts.
Exact VAT number match (companies only).
Exact legal identifier match (companies only).
Response
Successful Response
A page of relations, mixing both types.
Named subclass of Page only so the schema is called RelationPage in the docs: a
generic parametrised with an annotated union gets an unreadable generated name.
A business third party. Carries the fields an individual has no equivalent of
(vat, identifier, electronic_address, is_customer, is_supplier), and none of
the contact-only ones — first_name/last_name are simply absent from the response.
- CompanyRelationOut
- ContactRelationOut