Get Relation

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fidly.be/relations/{relation_uuid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fidly.be/relations/{relation_uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fidly.be/relations/{relation_uuid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fidly.be/relations/{relation_uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

relations

{relation_uuid}

Get Relation

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fidly.be/relations/{relation_uuid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fidly.be/relations/{relation_uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fidly.be/relations/{relation_uuid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fidly.be/relations/{relation_uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

relation_uuid

string

required

Response

Successful Response

CompanyRelationOut
ContactRelationOut

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.

string

required

Opaque unique identifier of the relation.

type

string

required

Relation type, always company here.

Allowed value: "company"

name

string | null

Display name. Company name for company, full name for contact.

string | null

Primary email address.

phone

string | null

Phone number.

language

string | null

Preferred language, one of ['fr', 'en', 'nl', 'de'].

address

AddressOut · object | null

Postal address, if known.

Show child attributes

vat

string | null

VAT number, prefixed with the ISO country code.

identifier

string | null

Legal registration / party identifier.

electronic_address

string | null

Electronic address used to send invoices over Peppol.

is_customer

boolean | null

true if this company is a customer.

is_supplier

boolean | null

true if this company is a supplier.

auth

documents

relations

delivery locations

bank accounts

journals

brandings

reference

health

Get Relation

Authorizations

Path Parameters

Response