Businesses

The businesses endpoint allows you to retrieve information about businesses connected to your account. This information is essential for accessing business-specific data like leads.

GET/api/businesses

List businesses

Retrieve a list of businesses connected to your account. Each business includes details about their company, contact information, and working area settings.

Response Fields

Name
id
Type
integer
Description
Unique identifier for the business. Use this ID to access business-specific endpoints like listing leads.
Name
company_name
Type
string
Description
Name of the company.
Name
email
Type
string
Description
Contact email address for the business.
Name
postal_code
Type
string
Description
Postal code of the business location.
Name
working_area_by
Type
string
Description
Method used to define the business's working area. Can be either "radius" or "region".
Name
working_area_radius_in_km
Type
integer|null
Description
Radius of the working area in kilometers. Only present when working_area_by is "radius".

Request

GET

/api/businesses

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

{
  "data": [
    {
      "id": 3854,
      "company_name": "OfferteAdviseur",
      "email": "info@offerteadviseur.nl",
      "postal_code": "3821CJ",
      "working_area_by": "radius",
      "working_area_radius_in_km": 300
    },
    {
      "id": 3864,
      "company_name": "Marshmallow",
      "email": "hello@marshmallow.dev",
      "postal_code": "2406AT",
      "working_area_by": "region",
      "working_area_radius_in_km": 20
    }
  ]
}