### Contact API Response Example

Source: https://docs.bizzy.ai/api-reference/company/contactDetails

An example of a successful (200 OK) response from the Contact API. It includes identifier details, enriched contact data such as name, job title, department, seniority, email, and mobile phone number, along with their status or any enrichment errors.

```json
{
    "identifier": {
        "contactId": 1207528048,
        "firstName": "Arne",
        "lastName": "Snauwaert"
    },
    "data": {
        "firstName": "Arne",
        "lastName": "Snauwaert",
        "fullName": "Arne Snauwaert",
        "linkedinUrl": "https://be.linkedin.com/in/arne-snauwaert",
        "jobTitle": "Head of Product & Engineering",
        "department": [
            "PRODUCT_MANAGEMENT",
            "C_SUITE"
        ],
        "seniority": [
            "DIRECTOR"
        ],
        "email": {
            "value": "info@bizzy.ai", 
            "status": "VALID"
        },
        "mobilePhone": {
            "value": "+32 000 00 00 00", 
            "dataProvider": "PROSPEO",
            "error": null
        }
    }
}
```

--------------------------------

### GET /websites/bizzy_ai

Source: https://docs.bizzy.ai/api-reference/lists/overview

Retrieves a list of websites with specified query parameters for filtering and pagination.

```APIDOC
## GET /websites/bizzy_ai

### Description
Retrieves a list of websites with options to filter by type, limit the number of results, and skip a certain number of items.

### Method
GET

### Endpoint
/websites/bizzy_ai

### Parameters
#### Query Parameters
- **type** (string) - Optional - List type to fetch. Can be `STATIC`, `SMART`, or `OVERVIEW` (returns both static and smart lists). Defaults to `OVERVIEW`.
- **limit** (number) - Optional - Number of items to return per page. Maximum is 500. Defaults to 4.
- **offset** (number) - Optional - Number of items to skip. Defaults to 0.

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of website list objects.
  - **id** (number) - Unique identifier for the list.
  - **name** (string) - The name of the list.
  - **type** (string) - The type of list (`STATIC` or `SMART`).
  - **columns** (array of strings) - The columns included in the list.
  - **shared** (boolean) - Indicates if the list is shared.
  - **notifications** (object) - Notification settings for the list.
    - **enabled** (boolean) - Whether notifications are enabled.
  - **amountOfCompanies** (number) - The number of companies in the list.
  - **newResults** (number | null) - For smart lists, the count of new results based on filters. For static lists, `null`.
  - **updatedAt** (string) - The timestamp of the last update.
  - **createdAt** (string) - The timestamp of creation.
  - **createdBy** (string) - The email of the user who created the list.
- **pagination** (object) - Pagination details for the response.
  - **limit** (number) - The limit applied to the request.
  - **offset** (number) - The offset applied to the request.
  - **total** (number) - The total number of available items.

#### Response Example
```json
{
    "data": [
        {
            "id": 1357924680,
            "name": "Example List One",
            "type": "STATIC",
            "columns": [
                "activities",
                "vatNumber",
                "country",
                "url",
                "socials"
            ],
            "shared": false,
            "notifications": {
                "enabled": true
            },
            "amountOfCompanies": 15,
            "newResults": null,
            "updatedAt": "2024-11-18T10:30:00.000Z",
            "createdAt": "2024-10-20T08:45:00.000Z",
            "createdBy": "jane.doe@example.com"
        },
        {
            "id": 246813579,
            "name": "Shared List",
            "type": "SMART",
            "columns": [
                "description"
            ],
            "shared": true,
            "notifications": {
                "enabled": false
            },
            "amountOfCompanies": 500,
            "newResults": 25,
            "updatedAt": "2024-11-19T12:00:00.000Z",
            "createdAt": "2024-10-05T11:30:10.000Z",
            "createdBy": "john.smith@example.com"
        },
        {
            "id": 1123581321,
            "name": "Static List A",
            "type": "STATIC",
            "columns": ["description"],
            "shared": false,
            "notifications": {
                "enabled": false
            },
            "amountOfCompanies": 8,
            "newResults": null,
            "updatedAt": "2024-11-16T18:15:19.000Z",
            "createdAt": "2024-09-25T14:10:00.000Z",
            "createdBy": "alex.brown@example.com"
        },
        {
            "id": 9988776655,
            "name": "Updated AI Filters",
            "type": "SMART",
            "columns": [
                "description"
            ],
            "shared": false,
            "notifications": {
                "enabled": false
            },
            "amountOfCompanies": 120,
            "newResults": 10,
            "updatedAt": "2024-11-19T07:45:00.000Z",
            "createdAt": "2024-10-10T10:20:10.000Z",
            "createdBy": "lisa.white@example.com"
        }
    ],
    "pagination": {
        "limit": 4,
        "offset": 0,
        "total": 50
    }
}
```
```

--------------------------------

### JSON Error Response Example

Source: https://docs.bizzy.ai/api-reference/usage/errors

This example demonstrates the structure of a typical JSON error response from the Bizzy AI API. It includes the HTTP status code and an optional human-readable error message.

```json
{
  "status": 400,
  "message": "Invalid query"
}
```

--------------------------------

### JSON Response Example - Bizzy AI Platform

Source: https://docs.bizzy.ai/api-reference/company/details

This snippet demonstrates a successful (200) JSON response from the Bizzy AI platform. It includes detailed company information such as identifier, status, description, address, website, social media links, contact information, NACE codes, and estimations for revenue and employees. The structure is designed to provide a comprehensive overview of a company's profile.

```json
{
  "identifier": {
    "country": "BE",
    "companyNumber": "770493071",
    "name": "Bizzy Fintech",
    "place": "Gent"
  },
  "data": {
    "status": "ACTIVE",
    "legalStatus": "NORMAL_SITUATION",
    "description": "Bizzy is a B2B intelligence platform that uses AI and machine learning to provide sales professionals, marketers, and investors with real-time insights and data on companies. Their solution helps users discover, qualify, and engage with companies more efficiently, allowing them to focus on the right leads and opportunities.",
    "logo": "https://bizzy.ams3.digitaloceanspaces.com/prod/companies/be/logos/fa6fd26d-f23a-416a-822e-624a0eca6e3b/100075701964481.png",
    "establishedSince": "2021-06-29T00:00:00.000Z",
    "stoppedSince": null,
    "entityType": "LEGAL_PERSON",
    "companyTypeCode": "PLC",
    "name": "Bizzy Fintech",
    "tradeNames": [
      {
        "name": "Bizzy Fintech"
      },
      {
        "name": "Bizzy"
      }
    ],
    "address": {
      "country": "BE",
      "street": "Dok-Noord",
      "number": "4E",
      "box": "//4",
      "postalCode": "9000",
      "place": "Gent"
    },
    "website": [
      "https://bizzy.ai"
    ],
    "socials": {
      "x": "https://twitter.com/bizzyinsights",
      "facebook": "https://www.facebook.com/bizzyinsights",
      "youtube": null,
      "instagram": "https://www.instagram.com/bizzyinsights/",
      "linkedin": "https://www.linkedin.com/company/bizzyinsights/"
    },
    "contact": {
      "email": "hello@bizzy.ai",
      "phone": null
    },
    "naceCodes": [
      {
        "code": "62010"
      },
      {
        "code": "62020"
      },
      {
        "code": "62090"
      },
      {
        "code": "70220"
      }
    ],
    "activities": [
      {
        "activity": "BUSINESS_CONSULTING"
      },
      {
        "activity": "DATA_ANALYTICS"
      }
    ],
    "revenueEstimations": "Bucket0_1M",
    "employeeEstimations": "Bucket10_19",
    "commonScore": "C",
    "creditLimit": 500
  }
}
```

--------------------------------

### GET /websites/bizzy_ai/contacts

Source: https://docs.bizzy.ai/api-reference/lists/contacts

Retrieves a list of contacts with support for pagination.

```APIDOC
## GET /websites/bizzy_ai/contacts

### Description
Retrieves a list of contacts with support for pagination. You can control the number of results returned and the number of results to skip.

### Method
GET

### Endpoint
/websites/bizzy_ai/contacts

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Number of items to return per page. (max 500) Defaults to 4.
- **offset** (number) - Optional - Number of items to skip. Defaults to 0.

### Response
#### Success Response (200)
- **data** (array) - An array of contact objects.
  - **jobTitle** (string) - The job title of the contact.
  - **identifier** (object) - An object containing the contact's identifier details.
    - **contactId** (number) - The unique ID of the contact.
    - **firstName** (string) - The first name of the contact.
    - **lastName** (string) - The last name of the contact.
  - **company** (object) - An object containing the contact's company details.
    - **country** (string) - The country code of the company.
    - **companyNumber** (string) - The company registration number.
    - **name** (string) - The name of the company.
    - **place** (string) - The city or place of the company.
- **pagination** (object) - An object containing pagination information.
  - **limit** (number) - The limit used for the current page.
  - **offset** (number) - The offset used for the current page.
  - **total** (number) - The total number of items available.

#### Response Example
```json
{
    "data": [
        {
            "jobTitle": "Head of Product & Engineering",
            "identifier": {
                "contactId": 1207528048,
                "firstName": "Arne",
                "lastName": "Snauwaert"
            },
            "company": {
                "country": "BE",
                "companyNumber": "770493071",
                "name": "Bizzy Fintech",
                "place": "Gent"
            }
        }
    ],
    "pagination": {
        "limit": 4,
        "offset": 0,
        "total": 1
    }
}
```
```

--------------------------------

### API Response Example - JSON

Source: https://docs.bizzy.ai/api-reference/lists/overview

This JSON structure represents a successful response from the Bizzy AI API when retrieving a list of items. It includes data for each item, such as ID, name, type, columns, sharing status, notification settings, company count, new results count, and timestamps. It also contains pagination information.

```json
{
    "data": [
        {
            "id": 1357924680,
            "name": "Example List One",
            "type": "STATIC",
            "columns": [
                "activities",
                "vatNumber",
                "country",
                "url",
                "socials"
            ],
            "shared": false,
            "notifications": {
                "enabled": true
            },
            "amountOfCompanies": 15,
            "newResults": null,
            "updatedAt": "2024-11-18T10:30:00.000Z",
            "createdAt": "2024-10-20T08:45:00.000Z",
            "createdBy": "jane.doe@example.com"
        },
        {
            "id": 246813579,
            "name": "Shared List",
            "type": "SMART",
            "columns": [
                "description"
            ],
            "shared": true,
            "notifications": {
                "enabled": false
            },
            "amountOfCompanies": 500,
            "newResults": 25,
            "updatedAt": "2024-11-19T12:00:00.000Z",
            "createdAt": "2024-10-05T11:30:10.000Z",
            "createdBy": "john.smith@example.com"
        },
        {
            "id": 1123581321,
            "name": "Static List A",
            "type": "STATIC",
            "columns": ["description"],
            "shared": false,
            "notifications": {
                "enabled": false
            },
            "amountOfCompanies": 8,
            "newResults": null,
            "updatedAt": "2024-11-16T18:15:19.000Z",
            "createdAt": "2024-09-25T14:10:00.000Z",
            "createdBy": "alex.brown@example.com"
        },
        {
            "id": 9988776655,
            "name": "Updated AI Filters",
            "type": "SMART",
            "columns": [
                "description"
            ],
            "shared": false,
            "notifications": {
                "enabled": false
            },
            "amountOfCompanies": 120,
            "newResults": 10,
            "updatedAt": "2024-11-19T07:45:00.000Z",
            "createdAt": "2024-10-10T10:20:10.000Z",
            "createdBy": "lisa.white@example.com"
        }
    ],
    "pagination": {
        "limit": 4,
        "offset": 0,
        "total": 50
    }
}
```

--------------------------------

### API Authentication Header Example

Source: https://docs.bizzy.ai/index

This snippet demonstrates the required format for the Authorization header when making requests to the Bizzy Public API. It uses a bearer token for authentication. Ensure you replace 'YOUR_TOKEN_HERE' with your actual API key.

```json
{
  "Authorization": "Bearer YOUR_TOKEN_HERE"
}
```

--------------------------------

### GET /company/{country}/{companyNumber}/lookalikes

Source: https://context7.com/context7/bizzy_ai/llms.txt

Finds companies that are similar to a given company using AI-powered matching.

```APIDOC
## GET /company/{country}/{companyNumber}/lookalikes

### Description
Find similar companies based on AI-powered matching algorithms for a specified company.

### Method
GET

### Endpoint
`/company/{country}/{companyNumber}/lookalikes`

### Parameters
#### Path Parameters
- **country** (string) - Required - The country code of the company (e.g., 'BE').
- **companyNumber** (string) - Required - The unique identification number of the company.

### Request Example
```bash
curl -X GET "https://api.bizzy.ai/company/BE/770493071/lookalikes" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Accept-Language: EN"
```

### Response
#### Success Response (200)
- **identifier** (object) - Information about the company for which lookalikes were found.
- **data** (array) - An array of similar companies.
  - **companyId** (object) - Identifier of the similar company.
    - **country** (string) - Country code of the similar company.
    - **companyNumber** (string) - Company number of the similar company.
  - **score** (number) - A score indicating the similarity to the requested company.

#### Response Example
```json
{
  "identifier": {
    "country": "BE",
    "companyNumber": "770493071",
    "name": "Bizzy Fintech",
    "place": "Gent"
  },
  "data": [
    {
      "companyId": {
        "country": "BE",
        "companyNumber": "568854619"
      },
      "score": 0.8994202558671441
    },
    {
      "companyId": {
        "country": "BE",
        "companyNumber": "746718173"
      },
      "score": 0.8795804344229533
    }
  ]
}
```
```

--------------------------------

### GET /websites/bizzy_ai/relationships

Source: https://docs.bizzy.ai/api-reference/company/relationships

Retrieves parent and child relationships for a specified company.

```APIDOC
## GET /websites/bizzy_ai/relationships

### Description
Retrieves parent and child relationships for a specified company.

### Method
GET

### Endpoint
/websites/bizzy_ai/relationships

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - countryCode can be either `BE`, `NL` or `FR`
- **companyNumber** (string) - Required - Belgium: Enterprise (KBO) number. This is equal to the VAT without ‘BE’. The Netherlands: KVK number France: SIREN number

#### Query Parameters
- **Accept-Language** (string) - Optional - Default: EN. Specifies the language for the response. Accepted values: NL (Dutch), FR (French), EN (English).

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **identifier** (object) - Information about the company.
  - **country** (string) - The country code.
  - **companyNumber** (string) - The company registration number.
  - **name** (string) - The name of the company.
  - **place** (string) - The city where the company is located.
- **data** (object) - Contains relationship data.
  - **parents** (array) - An array of parent companies.
    - **identifier** (object) - Information about the parent company (can be null).
      - **country** (string) - The country code.
      - **companyNumber** (string) - The company registration number.
      - **name** (string) - The name of the company.
      - **place** (string) - The city where the company is located.
    - **function** (string) - The relationship function (e.g., "SHAREHOLDER").
    - **percentage** (number) - The ownership percentage.
    - **name** (string) - The name of the parent entity.
  - **children** (array) - An array of child companies (currently empty).

#### Response Example
```json
{
  "identifier": {
    "country": "BE",
    "companyNumber": "770493071",
    "name": "Bizzy Fintech",
    "place": "Gent"
  },
  "data": {
    "parents": [
      {
        "identifier": {
          "country": "BE",
          "companyNumber": "770493071",
          "name": "Bizzy Fintech",
          "place": "Gent"
        },
        "function": "SHAREHOLDER",
        "percentage": 0.15,
        "name": "Bizzy Fintech"
      },
      {
        "identifier": {
          "country": "BE",
          "companyNumber": "770493071",
          "name": "Bizzy Fintech",
          "place": "Gent"
        },
        "function": "SHAREHOLDER",
        "percentage": 0.012,
        "name": "Bizzy Fintech"
      },
      {
        "identifier": {
          "country": "BE",
          "companyNumber": "770493071",
          "name": "Bizzy Fintech",
          "place": "Gent"
        },
        "function": "SHAREHOLDER",
        "percentage": 0.1171,
        "name": "Bizzy Fintech"
      },
      {
        "identifier": {
          "country": "BE",
          "companyNumber": "770493071",
          "name": "Bizzy Fintech",
          "place": "Gent"
        },
        "function": "SHAREHOLDER",
        "percentage": 0.0157,
        "name": "Bizzy Fintech"
      },
      {
        "identifier": null
      }
    ],
    "children": []
  }
}
```
```

--------------------------------

### GET /websites/bizzy_ai/companies

Source: https://docs.bizzy.ai/api-reference/lists/companies

Fetches a list of companies with options to filter by type and control pagination. It supports 'SAVED', 'ARCHIVED', 'NEW', or 'ALL' types, and allows specifying the number of items per page and the offset.

```APIDOC
## GET /websites/bizzy_ai/companies

### Description
Fetches a list of companies. You can filter by company type and control the pagination of results.

### Method
GET

### Endpoint
/websites/bizzy_ai/companies

### Parameters
#### Query Parameters
- **type** (string) - Optional - Smart list type to fetch. Can be `SAVED`, `ARCHIVED`, `NEW`, or `ALL`.
- **limit** (number) - Optional - Number of items to return per page. Maximum value is 500. Defaults to 4.
- **offset** (number) - Optional - Number of items to skip. Defaults to 0.

### Request Example
```json
{
  "query": {
    "type": "NEW",
    "limit": 10,
    "offset": 0
  }
}
```

### Response
#### Success Response (200)
- **matchedSince** (string) - The date the item matched the list's filters and was added as a new result, in ISO 8601 format.
- **identifier** (object) - Contains company identification details such as country, company number, name, and place.
- **pagination** (object) - Contains pagination details like limit, offset, and total number of items.

#### Response Example
```json
{
    "data": [
        {
            "identifier": {
                "country": "BE",
                "companyNumber": "441571714",
                "name": "TOYOTA MOTOR EUROPE",
                "place": "Evere"
            },
            "matchedSince": "2024-11-20T13:47:43.000Z"
        }
    ],
    "pagination": {
        "limit": 4,
        "offset": 0,
        "total": 50
    }
}
```
```

--------------------------------

### GET /websites/bizzy_ai/contact-details

Source: https://docs.bizzy.ai/api-reference/company/contactDetails

Retrieves contact details based on provided path and query parameters. Enrichment options are available.

```APIDOC
## GET /websites/bizzy_ai/contact-details

### Description
Retrieves contact details for a given company and contact ID. Optionally enriches the contact with email and mobile phone information.

### Method
GET

### Endpoint
`/websites/bizzy_ai/contact-details/{countryCode}/{companyNumber}/{contactId}`

### Parameters
#### Path Parameters
- **countryCode** (string) - Required - Country code (e.g., 'BE', 'NL', 'FR').
- **companyNumber** (string) - Required - Company registration number (KBO, KVK, or SIREN).
- **contactId** (string) - Required - Unique identifier for the contact.

#### Query Parameters
- **enrichEmail** (boolean) - Optional - Defaults to `false`. Set to `true` to enrich with email.
- **enrichMobilePhone** (boolean) - Optional - Defaults to `false`. Set to `true` to enrich with mobile phone.

### Request Example
```json
{
  "enrichEmail": true,
  "enrichMobilePhone": true
}
```

### Response
#### Success Response (200)
- **data.firstName** (string) - The first name of the contact.
- **data.lastName** (string) - The last name of the contact.
- **data.fullName** (string) - The full name of the contact.
- **data.linkedinUrl** (string) - The LinkedIn profile URL.
- **data.jobTitle** (string) - The job title of the contact.
- **data.department** (string[]) - An array of the contact's departments.
- **data.seniority** (string[]) - An array of the contact's seniority levels.
- **data.email** (object) - Email information, including value and status.
- **data.mobilePhone** (object) - Mobile phone information, including value, data provider, and potential errors.

#### Response Example
```json
{
    "identifier": {
        "contactId": 1207528048,
        "firstName": "Arne",
        "lastName": "Snauwaert"
    },
    "data": {
        "firstName": "Arne",
        "lastName": "Snauwaert",
        "fullName": "Arne Snauwaert",
        "linkedinUrl": "https://be.linkedin.com/in/arne-snauwaert",
        "jobTitle": "Head of Product & Engineering",
        "department": [
            "PRODUCT_MANAGEMENT",
            "C_SUITE"
        ],
        "seniority": [
            "DIRECTOR"
        ],
        "email": {
            "value": "info@bizzy.ai",
            "status": "VALID"
        },
        "mobilePhone": {
            "value": "+32 000 00 00 00",
            "dataProvider": "PROSPEO",
            "error": null
        }
    }
}
```
```

--------------------------------

### Get List Details using cURL

Source: https://context7.com/context7/bizzy_ai/llms.txt

This cURL command retrieves detailed information about a specific list, identified by its ID. An authorization token is required. The response includes list metadata such as name, type, columns, company count, and creation/update timestamps.

```Bash
curl -X GET "https://api.bizzy.ai/lists/1357924680" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"
```

--------------------------------

### GET /lists/{listId}/companies

Source: https://context7.com/context7/bizzy_ai/llms.txt

Fetches companies from a specific list, with options for filtering and pagination.

```APIDOC
## GET /lists/{listId}/companies

### Description
Fetch companies from a specific list with filtering options and pagination.

### Method
GET

### Endpoint
`/lists/{listId}/companies`

### Parameters
#### Path Parameters
- **listId** (integer) - Required - The unique identifier of the list.

#### Query Parameters
- **type** (string) - Optional - Filter companies by type (e.g., 'NEW').
- **limit** (integer) - Optional - The maximum number of companies to return per page.
- **offset** (integer) - Optional - The number of companies to skip.

### Request Example
```bash
curl -X GET "https://api.bizzy.ai/lists/1357924680/companies?type=NEW&limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"
```

### Response
#### Success Response (200)
- **data** (array) - An array of company objects from the list.
  - **identifier** (object) - Basic identification information for the company.
    - **country** (string) - Country code.
    - **companyNumber** (string) - Company identification number.
    - **name** (string) - Company name.
    - **place** (string) - City or place.
  - **matchedSince** (string) - Timestamp when the company was matched to the list.
- **pagination** (object) - Pagination details for the response.
  - **limit** (integer) - The limit used for this page.
  - **offset** (integer) - The offset used for this page.
  - **total** (integer) - The total number of companies available.

#### Response Example
```json
{
  "data": [
    {
      "identifier": {
        "country": "BE",
        "companyNumber": "441571714",
        "name": "TOYOTA MOTOR EUROPE",
        "place": "Evere"
      },
      "matchedSince": "2024-11-20T13:47:43.000Z"
    },
    {
      "identifier": {
        "country": "BE",
        "companyNumber": "403834160",
        "name": "Janssen Pharmaceutica",
        "place": "Beerse"
      },
      "matchedSince": "2024-11-20T13:47:43.000Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 50
  }
}
```
```

--------------------------------

### GET /company/{country}/{companyNumber}/financials

Source: https://context7.com/context7/bizzy_ai/llms.txt

Retrieves historical financial data for a specific company, including profitability, liquidity, and solvency metrics.

```APIDOC
## GET /company/{country}/{companyNumber}/financials

### Description
Access historical financial data including revenue, profitability, liquidity, and solvency metrics for a given company.

### Method
GET

### Endpoint
`/company/{country}/{companyNumber}/financials`

### Parameters
#### Path Parameters
- **country** (string) - Required - The country code of the company (e.g., 'BE').
- **companyNumber** (string) - Required - The unique identification number of the company.

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of financial records to return.
- **offset** (integer) - Optional - The number of financial records to skip.

### Request Example
```bash
curl -X GET "https://api.bizzy.ai/company/BE/770493071/financials?limit=5&offset=0" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Accept-Language: EN"
```

### Response
#### Success Response (200)
- **identifier** (object) - Information about the company.
- **data** (array) - An array of financial data objects for the company.
  - **startDate** (string) - The start date of the financial period.
  - **endDate** (string) - The end date of the financial period.
  - **dateReceived** (string) - The date the financial data was received.
  - **healthIndicator** (integer) - A health score for the company.
  - **jointCommitteeCodes** (array) - Codes related to joint committees.
  - **profitability** (object) - Profitability metrics.
  - **liquidity** (object) - Liquidity metrics.
  - **solvency** (object) - Solvency metrics.
  - **people** (object) - Information about company employees.
- **pagination** (object) - Pagination details for the response.

#### Response Example
```json
{
  "identifier": {
    "country": "BE",
    "companyNumber": "770493071",
    "name": "Bizzy Fintech",
    "place": "Gent"
  },
  "data": [
    {
      "startDate": "2023-01-01",
      "endDate": "2023-12-31",
      "dateReceived": "2024-07-31",
      "healthIndicator": 5,
      "jointCommitteeCodes": ["200"],
      "profitability": {
        "revenue": null,
        "grossMargin": -157493.98,
        "ebitda": -721635.55,
        "ebit": -909762.24,
        "netProfit": -924861.06
      },
      "liquidity": {
        "cash": 486301.02,
        "cashFlow": -736314.45,
        "netWorkingCapital": 13795.96,
        "currentRatio": 1.0196,
        "quickRatio": 1.6408
      },
      "solvency": {
        "totalAssets": 1198129.04,
        "equity": 115032.76,
        "debt": 1083096.28,
        "longTermDebt": 379351.41,
        "shortTermDebt": 404044.38
      },
      "people": {
        "employees": 12,
        "newHires": 6,
        "employeeMaleRatio": 0.9167,
        "employeeFemaleRatio": 0.0833
      }
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 2
  }
}
```
```

--------------------------------

### Get Company Details

Source: https://context7.com/context7/bizzy_ai/llms.txt

Retrieve detailed information for a specific company using its country code and company number. This endpoint may incur credit charges on first access.

```APIDOC
## GET /company/{country_code}/{company_number}

### Description
Retrieve detailed information for a specific company using its country code and company number. Credit charges may apply on the first access to a company's data.

### Method
GET

### Endpoint
`/company/{country_code}/{company_number}`

### Parameters
#### Path Parameters
- **country_code** (string) - Required - The ISO 3166-1 alpha-2 country code (e.g., BE, NL, FR).
- **company_number** (string) - Required - The unique company registration number.

#### Headers
- **Accept-Language** (string) - Optional - Specifies the preferred language for the response. Accepted values: `EN`, `NL`, `FR`.

### Request Example
```bash
curl -X GET "https://api.bizzy.ai/company/BE/770493071" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Accept-Language: FR"
```

### Response
#### Success Response (200)
- **[Company details object structure]**

#### Response Example
[Example response for company details would be provided here if available]
```

--------------------------------

### Access Company Data and Check Credits - Bash

Source: https://context7.com/context7/bizzy_ai/llms.txt

Accesses company data and shows how to check credit balance and charges in response headers. Initial access to company data incurs a credit charge.

```bash
curl -X GET "https://api.bizzy.ai/company/BE/770493071" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"

# Response headers include:
# X-Bizzy-Credits-Balance: 9850
# X-Bizzy-Credits-Charged: 1
```

--------------------------------

### Add Contact

Source: https://docs.bizzy.ai/api-reference/lists/contact

Adds a new contact to the system. Requires company number, country, and contact ID.

```APIDOC
## POST /websites/bizzy_ai/contact

### Description
Adds a new contact to the system. This endpoint only works for static lists.

### Method
POST

### Endpoint
/websites/bizzy_ai/contact

### Parameters
#### Request Body
- **companyNumber** (string) - Required - Belgium: Enterprise (KBO) number (VAT without ‘BE’). The Netherlands: KVK number. France: SIREN number.
- **country** (string) - Required - Country can be either `BE`, `NL` or `FR`.
- **contactId** (string) - Required - ContactId is the unique identifier of the contact.

### Request Example
```json
{
  "companyNumber": "0123456789",
  "country": "BE",
  "contactId": "contact_123"
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates successful contact addition.

#### Response Example
```json
{
  "message": "Contact added successfully"
}
```
```

--------------------------------

### GET /lists/{listId}

Source: https://context7.com/context7/bizzy_ai/llms.txt

Retrieves details about a specific saved or smart list.

```APIDOC
## GET /lists/{listId}

### Description
Retrieve details about a specific saved or smart list, including its name, type, and associated companies.

### Method
GET

### Endpoint
`/lists/{listId}`

### Parameters
#### Path Parameters
- **listId** (integer) - Required - The unique identifier of the list.

### Request Example
```bash
curl -X GET "https://api.bizzy.ai/lists/1357924680" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"
```

### Response
#### Success Response (200)
- **data** (array) - An array containing details of the requested list.
  - **id** (integer) - The list's unique identifier.
  - **name** (string) - The name of the list.
  - **type** (string) - The type of list (e.g., 'STATIC', 'SMART').
  - **columns** (array) - The fields included in the list.
  - **shared** (boolean) - Indicates if the list is shared.
  - **notifications** (object) - Notification settings for the list.
  - **amountOfCompanies** (integer) - The total number of companies in the list.
  - **newResults** (any) - Information about new results (can be null).
  - **updatedAt** (string) - The timestamp when the list was last updated.
  - **createdAt** (string) - The timestamp when the list was created.
  - **createdBy** (string) - The email address of the user who created the list.

#### Response Example
```json
{
  "data": [
    {
      "id": 1357924680,
      "name": "Example List One",
      "type": "STATIC",
      "columns": ["activities", "vatNumber", "country", "url", "socials"],
      "shared": false,
      "notifications": {
        "enabled": true
      },
      "amountOfCompanies": 15,
      "newResults": null,
      "updatedAt": "2024-11-18T10:30:00.000Z",
      "createdAt": "2024-10-20T08:45:00.000Z",
      "createdBy": "jane.doe@example.com"
    }
  ]
}
```
```

--------------------------------

### Get Company Contacts

Source: https://context7.com/context7/bizzy_ai/llms.txt

Retrieve contacts associated with a specific company. Supports pagination.

```APIDOC
## GET /company/{country_code}/{company_number}/contacts

### Description
Retrieve contacts associated with a specific company. Supports pagination with `limit` and `offset` query parameters.

### Method
GET

### Endpoint
`/company/{country_code}/{company_number}/contacts`

### Parameters
#### Path Parameters
- **country_code** (string) - Required - The ISO 3166-1 alpha-2 country code (e.g., BE, NL, FR).
- **company_number** (string) - Required - The unique company registration number.

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of contacts to return per page. Defaults to 20.
- **offset** (integer) - Optional - The number of contacts to skip before returning results. Defaults to 0.

### Request Example
```bash
curl -X GET "https://api.bizzy.ai/company/BE/770493071/contacts?limit=50&offset=100" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"
```

### Response
#### Success Response (200)
- **[Contact list structure for the company]**

#### Response Example
[Example response for company contacts would be provided here if available]
```

--------------------------------

### Pagination

Source: https://context7.com/context7/bizzy_ai/llms.txt

Paginated endpoints support `limit` and `offset` query parameters for efficient data retrieval.

```APIDOC
## Pagination

### Description
Endpoints that return lists of items support pagination using `limit` and `offset` query parameters. Results are generally sorted from newest to oldest.

### Query Parameters
- **limit** (integer) - Optional - Specifies the maximum number of items to return per page. (Default: 20)
- **offset** (integer) - Optional - Specifies the number of items to skip from the beginning of the result set. (Default: 0)

### Request Example
```bash
curl -X GET "https://api.bizzy.ai/company/BE/770493071/contacts?limit=50&offset=100" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"
```
```

--------------------------------

### Credit System

Source: https://context7.com/context7/bizzy_ai/llms.txt

Credits are consumed upon first access to company data and certain enrichment services. Subsequent access within 30 days is free.

```APIDOC
## Credit System

### Description
Credits are charged when accessing company data for the first time. Subsequent requests for the same company within 30 days are free. Credit usage can be monitored via response headers.

### Credit Charges
- Company details (first access): 1 credit
- Financials, Relationships, Lookalikes (first access): 1 credit per type
- Email enrichment (when available): 1 credit
- Mobile phone enrichment: 2 credits (1 credit with connected Prospeo account)
- Search and list endpoints: Free

### Response Headers
- **X-Bizzy-Credits-Balance**: The current available credit balance.
- **X-Bizzy-Credits-Charged**: The number of credits charged for the current request.

### Request Example
```bash
curl -X GET "https://api.bizzy.ai/company/BE/770493071" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"
```

### Response Example (Headers)
```
X-Bizzy-Credits-Balance: 9850
X-Bizzy-Credits-Charged: 1
```
```