Websites

The websites endpoint allows you to retrieve all websites connected to a specific affiliate. Each website has its own unique code that will be required when creating leads through the lead endpoint.

The website model

The website model contains information about each website associated with an affiliate.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the website.

  • Name
    name
    Type
    string
    Description

    Name of the website.

  • Name
    country
    Type
    string
    Description

    Country where the website operates.

  • Name
    url
    Type
    string
    Description

    Main URL of the website.

  • Name
    redirect_url
    Type
    string
    Description

    URL where users are redirected after certain actions.

  • Name
    code
    Type
    string
    Description

    Unique code used for creating leads. This code is required when using the lead endpoint.

GET/api/affiliates/:id/websites

List affiliate websites

Retrieve a paginated list of all websites associated with a specific affiliate. The affiliate ID is required and can be obtained from the affiliates endpoint. 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/1/websites
curl https://app.offerteadviseur.nl/api/affiliates/1/websites \
  -H "Authorization: Bearer eyJ..." \
  -H "Accept: application/json" \
  -G \
  -d page=1 \
  -d per_page=10

Response

{
  "data": [
    {
      "id": "1",
      "name": "OfferteAdviseur B.V.",
      "country": "Nederland",
      "url": "https://offerteadviseur.nl",
      "redirect_url": "https://offerteadviseur.nl/thank-you",
      "code": "1cd440df63f796a1f69da652cd0209"
    },
    {
      // ...
    }
  ],
  "links": {
    // ...
  },
  "meta": {
    // ...
  }
}

Was this page helpful?