Affiliates

The affiliates endpoint allows you to retrieve information about the companies associated with your account. Each affiliate represents a distinct business entity with its own details and can be linked to multiple websites. The affiliate ID obtained from this endpoint is required when retrieving the list of websites associated with each affiliate.

The affiliate model

The affiliate model contains comprehensive business information about each company associated with your account.

Properties

Name
id
Type
string
Description
Unique identifier for the affiliate.
Name
company_name
Type
string
Description
The registered name of the company.
Name
address
Type
string
Description
Street address of the company.
Name
postal_code
Type
string
Description
Postal code of the company address.
Name
city
Type
string
Description
City where the company is located.
Name
country
Type
string
Description
Country where the company is registered.
Name
coc_id
Type
string
Description
Chamber of Commerce registration number.
Name
iban
Type
string
Description
Partially masked IBAN number (e.g., "**************0966").

GET/api/affiliates

List all affiliates

Retrieve a paginated list of all affiliates associated with your account. The response includes company details with partially masked sensitive information. By default, the endpoint returns 10 items per page.

Query Parameters

Name
page
Type
integer
Description
The page number to retrieve. Defaults to 1.
Name
per_page
Type
integer
Description
Number of items per page. Defaults to 10, maximum 100.

Request

GET

/api/affiliates

curl https://app.offerteadviseur.nl/api/affiliates \
  -H "Authorization: Bearer eyJ..." \
  -H "Accept: application/json" \
  -G \
  -d page=1 \
  -d per_page=10

Response

{
  "data": [
    {
      "id": "1",
      "company_name": "OfferteAdviseur B.V.",
      "address": "De Dynamo 35",
      "postal_code": "3821CJ",
      "city": "Amersfoort",
      "country": "Nederland",
      "coc_id": "69684596",
      "iban": "**************0966"
    },
    // ...
  ],
  "links": {
    // ...
  },
  "meta": {
    // ...
  }
}

GET/api/affiliates/:id

Get affiliate

Retrieve detailed information about a specific affiliate by its ID.

Request

GET

/api/affiliates/1

curl https://app.offerteadviseur.nl/api/affiliates/1 \
 -H "Authorization: Bearer eyJ..." \
 -H "Accept: application/json"

Response

{
  "data": {
    "id": "1",
    "company_name": "OfferteAdviseur B.V.",
    "address": "De Dynamo 35",
    "postal_code": "3821CJ",
    "city": "Amersfoort",
    "country": "Nederland",
    "coc_id": "69684596",
    "iban": "**************0966"
  }
}