List Relations

GET /relations

List Relations

cURL

curl --request GET \
  --url https://api.fidly.be/relations \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "<string>",
      "type": "company",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "language": "<string>",
      "address": {
        "street": "<string>",
        "street_number": "<string>",
        "street2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "province": "<string>",
        "country_code": "<string>"
      },
      "vat": "<string>",
      "identifier": "<string>",
      "electronic_address": "<string>",
      "is_customer": true,
      "is_supplier": true
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer · default: 50

Max items returned (1–100).

Required range: 1 <= x <= 100

offset · integer · default: 0

Number of items to skip (pagination). Capped at 10000.

Required range: 0 <= x <= 10000

type · string | null

Filter by relation type: company or contact.

is_customer · boolean | null

Filter companies that are (not) customers. Excludes contacts.

is_supplier · boolean | null

Filter companies that are (not) suppliers. Excludes contacts.

vat · string | null

Exact VAT number match (companies only).

identifier · string | null

Exact legal identifier match (companies only).

Response

200

application/json

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.

items · (CompanyRelationOut · object | ContactRelationOut · object)[] · required

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

Show child attributes

total · integer · required

limit · integer · required

offset · integer · required