MENU navbar-image

Introduction

API REST du backoffice BougeMaVille — gestion des signalements citoyens, formulaires, utilisateurs et statistiques par municipalité.

This documentation aims to provide all the information you need to work with our API.

Base URL

https://api.demo.bouge.io

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

API Tokens

Gestion des tokens d'API par company (accès programmatique).

GET api/{company_id}/tokens

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/1/tokens" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/1/tokens"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company_id}/tokens

URL Parameters

company_id  integer  

The ID of the company.

POST api/{company_id}/tokens

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/1/tokens" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/1/tokens"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/{company_id}/tokens

URL Parameters

company_id  integer  

The ID of the company.

Auth

Authentication API

Forgot password

Envoie un email de réinitialisation de mot de passe.

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/forgot-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"operateur@maville.fr\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/forgot-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "operateur@maville.fr"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/forgot-password

Body Parameters

email  string  

Email du compte CRM pour lequel réinitialiser le mot de passe. validation.email.

Reset password

Réinitialise le mot de passe via le token reçu par email.

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/reset-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"operateur@maville.fr\",
    \"password\": \"nouveau_secret\",
    \"token_reset_password\": \"1|abc123...\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/reset-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "operateur@maville.fr",
    "password": "nouveau_secret",
    "token_reset_password": "1|abc123..."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/reset-password

Body Parameters

email  string  

Email du compte CRM. validation.email.

password  string  

Nouveau mot de passe.

token_reset_password  string  

Token reçu par email lors de la demande de réinitialisation.

Logout user

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/logout"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/logout

Show current user with his company

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/sunt/users/me" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/sunt/users/me"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/users/me

URL Parameters

company  string  

Show current user with his company

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/users/me" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/users/me"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/users/me

Login user

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/tokens" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"operateur@maville.fr\",
    \"password\": \"secret\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/tokens"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "operateur@maville.fr",
    "password": "secret"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "token": "1|abc123def456...",
    "user": {
        "id": 12,
        "name": "Marie Dupont",
        "email": "marie.dupont@maville.fr",
        "locale": "fr",
        "company_id": 3,
        "active": true
    }
}
 

Example response (401):


{
    "error": "Wrong username or password"
}
 

Example response (403):


{
    "error": "User deactivated"
}
 

Example response (422, Validation error):


{
    "message": "The email field is required.",
    "errors": {
        "email": [
            "The email field is required."
        ]
    }
}
 

Request      

POST api/tokens

Body Parameters

email  string  

Email de l'opérateur CRM.

password  string  

Mot de passe.

firebase  string optional  

Token Firebase pour les notifications push (optionnel).

Backoffice Info

Read-only consolidated endpoints for backoffice overview pages.

GET api/{company}/backoffice/forms/{formId}/info

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/quaerat/backoffice/forms/porro/info" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quaerat/backoffice/forms/porro/info"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/backoffice/forms/{formId}/info

URL Parameters

company  string  

formId  string  

GET api/{company}/backoffice/overview

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/et/backoffice/overview" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/et/backoffice/overview"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/backoffice/overview

URL Parameters

company  string  

Banoc geocoder

Proxy vers l'API de géocodage BANOC. Les paramètres sont transmis tels quels et la réponse retournée sans transformation.

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/banoc/geocode/search" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"commodi\",
    \"jurisd_local_id\": 5,
    \"format\": \"perspiciatis\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/banoc/geocode/search"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "q": "commodi",
    "jurisd_local_id": 5,
    "format": "perspiciatis"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 100
x-ratelimit-remaining: 99
vary: Origin
 

[]
 

GET api/banoc/geocode/coordinates

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/banoc/geocode/coordinates" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"latitude\": 7.887,
    \"longitude\": 59021989.5654816,
    \"level\": 20
}"
const url = new URL(
    "https://api.demo.bouge.io/api/banoc/geocode/coordinates"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "latitude": 7.887,
    "longitude": 59021989.5654816,
    "level": 20
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 100
x-ratelimit-remaining: 98
vary: Origin
 

{
    "message": "The geocode for latitude : 7.887000 and longitude : 59021989.565482 not found",
    "error": "NOT_FOUND_GEOCODE",
    "status": 404
}
 

Request      

GET api/banoc/geocode/coordinates

Body Parameters

latitude  number  

longitude  number  

level  integer  

Company

Gestion des paramètres et de la configuration de la company (municipalité).

List public companies

Retourne la liste des municipalités actives et listables (sans authentification).

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/public/companies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/public/companies"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 998
vary: Origin
 

{
    "companies": [
        {
            "name": "Coeur du Web",
            "uuid": "fea123e4-e326-4023-91bf-044f78505907"
        },
        {
            "name": "Support Le Tram",
            "uuid": "48bee9ba-86d5-41e4-90d7-9e5108cecb64"
        }
    ]
}
 

Request      

GET api/public/companies

Get token by API key

Génère un token Sanctum à partir d'une clé API externe (accès programmatique).

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/company/token/7" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/company/token/7"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 990
vary: Origin
 

{
    "message": "",
    "exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
    "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
    "line": 1169,
    "trace": [
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/helpers.php",
            "line": 45,
            "function": "abort",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/app/Http/Controllers/Company/CompanyController.php",
            "line": 216,
            "function": "abort"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Controller.php",
            "line": 54,
            "function": "getToken",
            "class": "App\\Http\\Controllers\\Company\\CompanyController",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/ControllerDispatcher.php",
            "line": 43,
            "function": "callAction",
            "class": "Illuminate\\Routing\\Controller",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 259,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 205,
            "function": "runController",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 798,
            "function": "run",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Routing\\Router::runRouteWithinStack():797}",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php",
            "line": 50,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 126,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 92,
            "function": "handleRequest",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 54,
            "function": "handleRequestUsingNamedLimiter",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 797,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 190,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Foundation\\Http\\Kernel::dispatchToRouter():187}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestIpMiddleware.php",
            "line": 45,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestIpMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestMiddleware.php",
            "line": 31,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/fruitcake/laravel-cors/src/HandleCors.php",
            "line": 52,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 39,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 165,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 134,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 176,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 41,
            "function": "{closure:Illuminate\\Container\\BoundMethod::call():35}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 661,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 183,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Command/Command.php",
            "line": 326,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 152,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 1098,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 324,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 175,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Application.php",
            "line": 102,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 155,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/artisan",
            "line": 35,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}
 

Request      

GET api/company/token/{apiKey}

URL Parameters

apiKey  integer  

GET api/companies

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/companies" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/companies"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/companies

POST api/companies

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/companies" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ugoeyzzhcuzwflqvlkdyyikskrjgcvkbgdargskcdivprmhodnxszoawdnorqchqilhftxpwjhipmyevbuezxnzwuwxxevmc\",
    \"slug\": \"buuxofzgorrieqxiemyayxbyliaqpipfugrbeufazsnmseklsuwupxvsjlnktetyrmuttapdnncgczvajndbwwnjgurwtsvzqzfnieukqmeoxgdul\",
    \"active\": true,
    \"is_listable\": false,
    \"mail_admin\": \"lina15@example.net\",
    \"settings_logo\": {
        \"name\": \"cum\",
        \"encodedFile\": \"ratione\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/companies"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ugoeyzzhcuzwflqvlkdyyikskrjgcvkbgdargskcdivprmhodnxszoawdnorqchqilhftxpwjhipmyevbuezxnzwuwxxevmc",
    "slug": "buuxofzgorrieqxiemyayxbyliaqpipfugrbeufazsnmseklsuwupxvsjlnktetyrmuttapdnncgczvajndbwwnjgurwtsvzqzfnieukqmeoxgdul",
    "active": true,
    "is_listable": false,
    "mail_admin": "lina15@example.net",
    "settings_logo": {
        "name": "cum",
        "encodedFile": "ratione"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/companies

Body Parameters

name  string  

validation.max.

slug  string  

validation.max.

active  boolean optional  

is_listable  boolean optional  

mail_admin  string optional  

validation.email.

settings_logo  object optional  

settings_logo.name  string optional  

validation.required_with.

settings_logo.encodedFile  string optional  

validation.required_with.

GET api/companies/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/companies/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/companies/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/companies/{id}

URL Parameters

id  integer  

The ID of the company.

PUT api/companies/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/companies/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"hkstihsqnulkktptle\",
    \"slug\": \"yvzlammfxvafabbxpgtquibmxdzjwoperbuepqrlwulmshosfspvcxhfeauzcnzbmjzchslykesiwswgstvictkbytaoyetejpotnuhosacmdmzytkurytqqqxeopnjarqrscmlobrxooyrcibrhjpfvlwihawohbgxguqnyhlzujqcnmaazmuqtbrvxwnkjgxehbvgmrnxbkcmxfwuofmvzwolazqopenx\",
    \"active\": true,
    \"is_listable\": false,
    \"mail_admin\": \"rcrooks@example.org\",
    \"settings_logo\": {
        \"name\": \"beatae\",
        \"encodedFile\": \"sit\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/companies/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "hkstihsqnulkktptle",
    "slug": "yvzlammfxvafabbxpgtquibmxdzjwoperbuepqrlwulmshosfspvcxhfeauzcnzbmjzchslykesiwswgstvictkbytaoyetejpotnuhosacmdmzytkurytqqqxeopnjarqrscmlobrxooyrcibrhjpfvlwihawohbgxguqnyhlzujqcnmaazmuqtbrvxwnkjgxehbvgmrnxbkcmxfwuofmvzwolazqopenx",
    "active": true,
    "is_listable": false,
    "mail_admin": "rcrooks@example.org",
    "settings_logo": {
        "name": "beatae",
        "encodedFile": "sit"
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/companies/{id}

URL Parameters

id  integer  

The ID of the company.

Body Parameters

name  string  

validation.max.

slug  string  

validation.max.

active  boolean optional  

is_listable  boolean optional  

mail_admin  string optional  

validation.email.

settings_logo  object optional  

settings_logo.name  string optional  

validation.required_with.

settings_logo.encodedFile  string optional  

validation.required_with.

PUT api/companies/{id}/active

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/companies/1/active" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"active\": false
}"
const url = new URL(
    "https://api.demo.bouge.io/api/companies/1/active"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "active": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/companies/{id}/active

URL Parameters

id  integer  

The ID of the company.

Body Parameters

active  boolean  

Return company resource

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/et/mycompany" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/et/mycompany"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/mycompany

URL Parameters

company  string  

GET api/{company}/company/settings

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/voluptas/company/settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/voluptas/company/settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/company/settings

URL Parameters

company  string  

POST api/{company}/company/settings

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/omnis/company/settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"settings_sender_mail\": \"gitbqriqbjsunvzrpyvzolojedwnhwgptspxgdakxycbcgdwpvjehoyqkxdmqofcyzjtaybbwpijjxtkhfeqqgteyfdzkinfp\",
    \"settings_sender_name\": \"zgwyuxmyletzqwjlpdqgqyzroccnxpiniyxccbiivvuasolfoqnbglgtoxcrqfaxjalzzolqotgltyrjibzuvgwgojdzycjqclzzmyoapyqkcpyyuujbkhzocsotmpusxcifpfykoperebrlbbosrrxwmzerog\",
    \"settings_mail_protocol\": \"dolorum\",
    \"settings_mail_host\": \"axnwiubzgtrobfguegvnmcpiczeqbzbibegpmrclpxevrdnyrzoccvsxyubusspkszahiuqaytadnzddjqftezbfwrtn\",
    \"settings_mail_port\": 14,
    \"settings_mail_username\": \"mbkunclyucuuzequziieygmpdaaesqdclzocyqhcfaqtafdiuyrzmuxglbagusecvhustfxc\",
    \"settings_mail_password\": \"hqdevihovisthodmbqkdmabpewedynmpkknuixyfnishbhezechpxvhzmcjntlbwrutzjjmgfdmnnkgorpjelciusnsdscbgrrtmjelcpkgumraogwstvjemqopqiheqbegnmsqrfwngxnfbnihvqwmdjlqsjfhfbwhgjxjmnhyuipirputhbtjltvrbgtkz\",
    \"settings_mail_password_confirmation\": \"sqcxnkvrpjgojfbqkdabucpvrgcamjebsurrknnthdxklmnuvocnkwelvqqgfghaihqkpzdwifhttnozfugqoemqsxvgehjhmeveagxbdxjaobtqfswrippxtuxwuhsdbwsfzikafvcwzezaajutvokgyczlmpfsmqsnexwz\",
    \"wa_phone_number_id\": \"spsqtfvjmiptxlyihavndaisipnubpeceaffzbnwclgvlwxufqbilvtsgmzusqzzlkliqodzpihwnoeujnfqwwirbedzxwkkmbstdajzgrbspfubuchbylzscqzbiqkphxalrwnlbzyogdqrhdshmsaqtksezkmlxjvfturwouaqaxmvgouuvjffgeiykxsgvjoncpstoqrcjrfhglxrkvzdjdsqpiekuyeoxlktgdvz\",
    \"wa_access_token\": \"natus\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/omnis/company/settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "settings_sender_mail": "gitbqriqbjsunvzrpyvzolojedwnhwgptspxgdakxycbcgdwpvjehoyqkxdmqofcyzjtaybbwpijjxtkhfeqqgteyfdzkinfp",
    "settings_sender_name": "zgwyuxmyletzqwjlpdqgqyzroccnxpiniyxccbiivvuasolfoqnbglgtoxcrqfaxjalzzolqotgltyrjibzuvgwgojdzycjqclzzmyoapyqkcpyyuujbkhzocsotmpusxcifpfykoperebrlbbosrrxwmzerog",
    "settings_mail_protocol": "dolorum",
    "settings_mail_host": "axnwiubzgtrobfguegvnmcpiczeqbzbibegpmrclpxevrdnyrzoccvsxyubusspkszahiuqaytadnzddjqftezbfwrtn",
    "settings_mail_port": 14,
    "settings_mail_username": "mbkunclyucuuzequziieygmpdaaesqdclzocyqhcfaqtafdiuyrzmuxglbagusecvhustfxc",
    "settings_mail_password": "hqdevihovisthodmbqkdmabpewedynmpkknuixyfnishbhezechpxvhzmcjntlbwrutzjjmgfdmnnkgorpjelciusnsdscbgrrtmjelcpkgumraogwstvjemqopqiheqbegnmsqrfwngxnfbnihvqwmdjlqsjfhfbwhgjxjmnhyuipirputhbtjltvrbgtkz",
    "settings_mail_password_confirmation": "sqcxnkvrpjgojfbqkdabucpvrgcamjebsurrknnthdxklmnuvocnkwelvqqgfghaihqkpzdwifhttnozfugqoemqsxvgehjhmeveagxbdxjaobtqfswrippxtuxwuhsdbwsfzikafvcwzezaajutvokgyczlmpfsmqsnexwz",
    "wa_phone_number_id": "spsqtfvjmiptxlyihavndaisipnubpeceaffzbnwclgvlwxufqbilvtsgmzusqzzlkliqodzpihwnoeujnfqwwirbedzxwkkmbstdajzgrbspfubuchbylzscqzbiqkphxalrwnlbzyogdqrhdshmsaqtksezkmlxjvfturwouaqaxmvgouuvjffgeiykxsgvjoncpstoqrcjrfhglxrkvzdjdsqpiekuyeoxlktgdvz",
    "wa_access_token": "natus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/company/settings

URL Parameters

company  string  

Body Parameters

settings_sender_mail  string optional  

validation.max.

settings_sender_name  string optional  

validation.max.

settings_mail_protocol  string optional  

settings_mail_host  string optional  

validation.max.

settings_mail_port  integer optional  

settings_mail_username  string optional  

validation.max.

settings_mail_password  string optional  

validation.max.

settings_mail_password_confirmation  string optional  

validation.max.

logo_settings  string optional  

wa_phone_number_id  string optional  

validation.max.

wa_access_token  string optional  

POST api/{company}/company/settings/header

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/porro/company/settings/header" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/porro/company/settings/header"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/{company}/company/settings/header

URL Parameters

company  string  

POST api/{company}/company/settings/whatsapp/test

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/laborum/company/settings/whatsapp/test" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"wa_phone_number_id\": \"cum\",
    \"wa_access_token\": \"maiores\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/laborum/company/settings/whatsapp/test"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "wa_phone_number_id": "cum",
    "wa_access_token": "maiores"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/company/settings/whatsapp/test

URL Parameters

company  string  

Body Parameters

wa_phone_number_id  string  

wa_access_token  string optional  

GET api/{company}/modules/{default}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/amet/modules/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/amet/modules/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/modules/{default}

URL Parameters

company  string  

default  integer  

Events

Backoffice events and projects management

GET api/{company}/events

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/placeat/events" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/placeat/events"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/events

URL Parameters

company  string  

POST api/{company}/events

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/ea/events" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"project\",
    \"title\": \"rzjerarzacbxsfkwazitgqhfdyvpfakpzrdgygolvjspwixvtctidabdahermqdpsrbyueudwcdwmwghoyixbldmaahencnsqaivcayquy\",
    \"description\": \"occaecati\",
    \"cover_media_id\": 7,
    \"start_date\": \"2026-06-04T21:33:29\",
    \"end_date\": \"2072-09-29\",
    \"location\": {
        \"address\": \"ivmljpsvxhifacpuasfqhrxbfmfxdwmuqyoahfihcmmckkgkynknwoksqzvwlenynkdllybfiijlzwjajspycdyvdpxpewtjgysbjdd\",
        \"lat\": 14,
        \"lng\": 99
    },
    \"is_featured\": true
}"
const url = new URL(
    "https://api.demo.bouge.io/api/ea/events"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "project",
    "title": "rzjerarzacbxsfkwazitgqhfdyvpfakpzrdgygolvjspwixvtctidabdahermqdpsrbyueudwcdwmwghoyixbldmaahencnsqaivcayquy",
    "description": "occaecati",
    "cover_media_id": 7,
    "start_date": "2026-06-04T21:33:29",
    "end_date": "2072-09-29",
    "location": {
        "address": "ivmljpsvxhifacpuasfqhrxbfmfxdwmuqyoahfihcmmckkgkynknwoksqzvwlenynkdllybfiijlzwjajspycdyvdpxpewtjgysbjdd",
        "lat": 14,
        "lng": 99
    },
    "is_featured": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/events

URL Parameters

company  string  

Body Parameters

type  string optional  

Must be one of event or project.

title  string  

validation.max.

description  string optional  

cover_media_id  integer optional  

start_date  string  

validation.date.

end_date  string optional  

validation.date validation.after_or_equal.

location  object optional  

location.address  string optional  

validation.max.

location.lat  number optional  

validation.between.

location.lng  number optional  

validation.between.

is_featured  boolean optional  

GET api/{company}/events/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/quaerat/events/8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quaerat/events/8"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/events/{id}

URL Parameters

company  string  

id  integer  

The ID of the event.

PUT api/{company}/events/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/asperiores/events/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"project\",
    \"title\": \"xmzswrvfwr\",
    \"description\": \"modi\",
    \"cover_media_id\": 14,
    \"start_date\": \"2026-06-04T21:33:29\",
    \"end_date\": \"2118-10-11\",
    \"location\": {
        \"address\": \"vfrxtucgjwhllxiqpqffavbrnzgqpwidsiimkyfrfzcgbihieognfssplvbbiisfruymjkbqhyrdoamirmenshmhwwyjwxihsjwjhupyrqrdgxhmfspjjzoe\",
        \"lat\": 68,
        \"lng\": 50
    },
    \"is_featured\": true
}"
const url = new URL(
    "https://api.demo.bouge.io/api/asperiores/events/7"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "project",
    "title": "xmzswrvfwr",
    "description": "modi",
    "cover_media_id": 14,
    "start_date": "2026-06-04T21:33:29",
    "end_date": "2118-10-11",
    "location": {
        "address": "vfrxtucgjwhllxiqpqffavbrnzgqpwidsiimkyfrfzcgbihieognfssplvbbiisfruymjkbqhyrdoamirmenshmhwwyjwxihsjwjhupyrqrdgxhmfspjjzoe",
        "lat": 68,
        "lng": 50
    },
    "is_featured": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/events/{id}

URL Parameters

company  string  

id  integer  

The ID of the event.

Body Parameters

type  string optional  

Must be one of event or project.

title  string  

validation.max.

description  string optional  

cover_media_id  integer optional  

start_date  string  

validation.date.

end_date  string optional  

validation.date validation.after_or_equal.

location  object optional  

location.address  string optional  

validation.max.

location.lat  number optional  

validation.between.

location.lng  number optional  

validation.between.

is_featured  boolean optional  

DELETE api/{company}/events/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/repellat/events/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/repellat/events/14"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/events/{id}

URL Parameters

company  string  

id  integer  

The ID of the event.

PUT api/{company}/events/{id}/publish

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/facilis/events/1/publish" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/facilis/events/1/publish"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/{company}/events/{id}/publish

URL Parameters

company  string  

id  integer  

The ID of the event.

PUT api/{company}/events/{id}/unpublish

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/corrupti/events/4/unpublish" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/corrupti/events/4/unpublish"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/{company}/events/{id}/unpublish

URL Parameters

company  string  

id  integer  

The ID of the event.

PUT api/{company}/events/{id}/cancel

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/dignissimos/events/13/cancel" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/dignissimos/events/13/cancel"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/{company}/events/{id}/cancel

URL Parameters

company  string  

id  integer  

The ID of the event.

Form

Form API endpoints

Show a form as if it's displayed to public user

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/autem/forms/voluptatem/public" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/autem/forms/voluptatem/public"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/forms/{id}/public

URL Parameters

company  string  

id  string  

The ID of the form.

Toggle active state of a form.

requires authentication

Example request:
curl --request PATCH \
    "https://api.demo.bouge.io/api/est/forms/impedit/toggle-active" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/est/forms/impedit/toggle-active"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/{company}/forms/{id}/toggle-active

URL Parameters

company  string  

id  string  

The ID of the form.

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/voluptas/forms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/voluptas/forms"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/forms

URL Parameters

company  string  

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/excepturi/forms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 598,
    \"fr\": {
        \"name\": \"Signalement voirie\",
        \"description\": \"Formulaire pour signaler un problème de voirie.\"
    },
    \"en\": {
        \"name\": \"Road issue report\",
        \"description\": \"Form to report a road issue.\"
    },
    \"form_type_id\": 1,
    \"racis\": [
        1,
        2
    ],
    \"steps\": [
        {
            \"id\": 18,
            \"fr\": [
                \"tempore\"
            ],
            \"en\": [
                \"earum\"
            ],
            \"attributes\": [
                {
                    \"id\": 13,
                    \"form_attribute_type_id\": 17,
                    \"hidden\": true,
                    \"private\": false,
                    \"requiredPublic\": true,
                    \"requiredBackoffice\": false,
                    \"config\": [
                        \"totam\"
                    ],
                    \"en\": [
                        \"quas\"
                    ],
                    \"fr\": [
                        \"consequuntur\"
                    ]
                }
            ]
        }
    ]
}"
const url = new URL(
    "https://api.demo.bouge.io/api/excepturi/forms"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 598,
    "fr": {
        "name": "Signalement voirie",
        "description": "Formulaire pour signaler un problème de voirie."
    },
    "en": {
        "name": "Road issue report",
        "description": "Form to report a road issue."
    },
    "form_type_id": 1,
    "racis": [
        1,
        2
    ],
    "steps": [
        {
            "id": 18,
            "fr": [
                "tempore"
            ],
            "en": [
                "earum"
            ],
            "attributes": [
                {
                    "id": 13,
                    "form_attribute_type_id": 17,
                    "hidden": true,
                    "private": false,
                    "requiredPublic": true,
                    "requiredBackoffice": false,
                    "config": [
                        "totam"
                    ],
                    "en": [
                        "quas"
                    ],
                    "fr": [
                        "consequuntur"
                    ]
                }
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/forms

URL Parameters

company  string  

Body Parameters

id  number optional  

fr  object optional  

fr.name  string  

Nom du formulaire en français. validation.max.

fr.description  string  

Description du formulaire en français.

en  object optional  

en.name  string  

Nom du formulaire en anglais. validation.max.

en.description  string  

Description du formulaire en anglais.

form_type_id  number  

ID du type de formulaire auquel appartient ce formulaire.

racis  string[] optional  

Liste des IDs d'utilisateurs assignés en RACI sur ce formulaire (optionnel).

steps  object[] optional  

steps[].id  integer optional  

steps[].fr  string[] optional  

steps[].en  string[] optional  

steps[].attributes  object[] optional  

steps[].attributes[].id  integer optional  

steps[].attributes[].form_attribute_type_id  integer optional  

steps[].attributes[].hidden  boolean optional  

steps[].attributes[].private  boolean optional  

steps[].attributes[].requiredPublic  boolean optional  

steps[].attributes[].requiredBackoffice  boolean optional  

steps[].attributes[].config  string[]  

steps[].attributes[].en  string[]  

steps[].attributes[].fr  string[]  

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/alias/forms/totam" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/alias/forms/totam"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/forms/{id}

URL Parameters

company  string  

id  string  

The ID of the form.

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/vel/forms/aut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 23952.7,
    \"fr\": {
        \"name\": \"Signalement voirie\",
        \"description\": \"Formulaire pour signaler un problème de voirie.\"
    },
    \"en\": {
        \"name\": \"Road issue report\",
        \"description\": \"Form to report a road issue.\"
    },
    \"form_type_id\": 1,
    \"racis\": [
        1,
        2
    ],
    \"steps\": [
        {
            \"id\": 19,
            \"fr\": [
                \"odit\"
            ],
            \"en\": [
                \"laborum\"
            ],
            \"attributes\": [
                {
                    \"id\": 19,
                    \"form_attribute_type_id\": 16,
                    \"hidden\": true,
                    \"private\": true,
                    \"requiredPublic\": true,
                    \"requiredBackoffice\": false,
                    \"config\": [
                        \"harum\"
                    ],
                    \"en\": [
                        \"hic\"
                    ],
                    \"fr\": [
                        \"non\"
                    ]
                }
            ]
        }
    ]
}"
const url = new URL(
    "https://api.demo.bouge.io/api/vel/forms/aut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 23952.7,
    "fr": {
        "name": "Signalement voirie",
        "description": "Formulaire pour signaler un problème de voirie."
    },
    "en": {
        "name": "Road issue report",
        "description": "Form to report a road issue."
    },
    "form_type_id": 1,
    "racis": [
        1,
        2
    ],
    "steps": [
        {
            "id": 19,
            "fr": [
                "odit"
            ],
            "en": [
                "laborum"
            ],
            "attributes": [
                {
                    "id": 19,
                    "form_attribute_type_id": 16,
                    "hidden": true,
                    "private": true,
                    "requiredPublic": true,
                    "requiredBackoffice": false,
                    "config": [
                        "harum"
                    ],
                    "en": [
                        "hic"
                    ],
                    "fr": [
                        "non"
                    ]
                }
            ]
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/forms/{id}

PATCH api/{company}/forms/{id}

URL Parameters

company  string  

id  string  

The ID of the form.

Body Parameters

id  number optional  

fr  object optional  

fr.name  string  

Nom du formulaire en français. validation.max.

fr.description  string  

Description du formulaire en français.

en  object optional  

en.name  string  

Nom du formulaire en anglais. validation.max.

en.description  string  

Description du formulaire en anglais.

form_type_id  number  

ID du type de formulaire auquel appartient ce formulaire.

racis  string[] optional  

Liste des IDs d'utilisateurs assignés en RACI sur ce formulaire (optionnel).

steps  object[] optional  

steps[].id  integer optional  

steps[].fr  string[] optional  

steps[].en  string[] optional  

steps[].attributes  object[] optional  

steps[].attributes[].id  integer optional  

steps[].attributes[].form_attribute_type_id  integer optional  

steps[].attributes[].hidden  boolean optional  

steps[].attributes[].private  boolean optional  

steps[].attributes[].requiredPublic  boolean optional  

steps[].attributes[].requiredBackoffice  boolean optional  

steps[].attributes[].config  string[]  

steps[].attributes[].en  string[]  

steps[].attributes[].fr  string[]  

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/quia/forms/ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quia/forms/ut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/forms/{id}

URL Parameters

company  string  

id  string  

The ID of the form.

Return all Response Template for all form for a specified company

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/ipsa/response-template" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/ipsa/response-template"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/response-template

URL Parameters

company  string  

Create a new Response Template for a form

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/ea/response-template" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"response_title\": \"n\",
    \"response_content\": \"perspiciatis\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/ea/response-template"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "response_title": "n",
    "response_content": "perspiciatis"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/response-template

URL Parameters

company  string  

Body Parameters

response_title  string  

validation.min.

response_content  string  

Return all Response Template for a specified company and specified form

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/voluptatem/response-template/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/voluptatem/response-template/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/response-template/{id}

URL Parameters

company  string  

id  integer  

The ID of the response template.

Update response template based on its ID

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/ullam/response-template/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"response_title\": \"\",
    \"response_content\": \"dolor\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/ullam/response-template/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "response_title": "",
    "response_content": "dolor"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/response-template/{id}

PATCH api/{company}/response-template/{id}

URL Parameters

company  string  

id  integer  

The ID of the response template.

Body Parameters

response_title  string  

validation.min.

response_content  string  

Delete template based on its ID

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/vel/response-template/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/vel/response-template/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/response-template/{id}

URL Parameters

company  string  

id  integer  

The ID of the response template.

Get a response template based on its ID

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/modi/response-template/1/get" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/modi/response-template/1/get"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/response-template/{templateId}/get

URL Parameters

company  string  

templateId  integer  

Form Status Actions

Manage actions triggered on form status change

GET api/{company}/forms/{form_id}/statuses/{status_id}/actions

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/ea/forms/qui/statuses/voluptas/actions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/ea/forms/qui/statuses/voluptas/actions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/forms/{form_id}/statuses/{status_id}/actions

URL Parameters

company  string  

form_id  string  

The ID of the form.

status_id  string  

The ID of the status.

POST api/{company}/forms/{form}/statuses/{status}/actions

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/quo/forms/rerum/statuses/pariatur/actions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"config\": [
        \"praesentium\"
    ],
    \"order\": 5,
    \"active\": false
}"
const url = new URL(
    "https://api.demo.bouge.io/api/quo/forms/rerum/statuses/pariatur/actions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "config": [
        "praesentium"
    ],
    "order": 5,
    "active": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/forms/{form}/statuses/{status}/actions

URL Parameters

company  string  

form  string  

The form.

status  string  

The status.

Body Parameters

type  string optional  

config  string[] optional  

order  integer optional  

active  boolean optional  

PUT api/{company}/forms/{form_id}/statuses/{status_id}/actions/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/molestiae/forms/hic/statuses/laborum/actions/quia" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"config\": [
        \"vero\"
    ],
    \"order\": 16,
    \"active\": true
}"
const url = new URL(
    "https://api.demo.bouge.io/api/molestiae/forms/hic/statuses/laborum/actions/quia"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "config": [
        "vero"
    ],
    "order": 16,
    "active": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/forms/{form_id}/statuses/{status_id}/actions/{id}

PATCH api/{company}/forms/{form_id}/statuses/{status_id}/actions/{id}

URL Parameters

company  string  

form_id  string  

The ID of the form.

status_id  string  

The ID of the status.

id  string  

The ID of the action.

Body Parameters

config  string[] optional  

order  integer optional  

active  boolean optional  

DELETE api/{company}/forms/{form_id}/statuses/{status_id}/actions/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/rerum/forms/repudiandae/statuses/et/actions/corporis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/rerum/forms/repudiandae/statuses/et/actions/corporis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/forms/{form_id}/statuses/{status_id}/actions/{id}

URL Parameters

company  string  

form_id  string  

The ID of the form.

status_id  string  

The ID of the status.

id  string  

The ID of the action.

Form Status Versions

Timeline / changelog of form status configurations

GET api/{company}/forms/{form_id}/statuses/{status_id}/versions

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/nam/forms/ut/statuses/reiciendis/versions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/nam/forms/ut/statuses/reiciendis/versions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/forms/{form_id}/statuses/{status_id}/versions

URL Parameters

company  string  

form_id  string  

The ID of the form.

status_id  string  

The ID of the status.

GET api/{company}/forms/{form_id}/statuses/{status_id}/versions/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/aspernatur/forms/praesentium/statuses/aliquid/versions/ipsa" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/aspernatur/forms/praesentium/statuses/aliquid/versions/ipsa"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/forms/{form_id}/statuses/{status_id}/versions/{id}

URL Parameters

company  string  

form_id  string  

The ID of the form.

status_id  string  

The ID of the status.

id  string  

The ID of the version.

POST api/{company}/forms/{form}/statuses/{status}/versions/{version}/restore

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/voluptatem/forms/sed/statuses/vero/versions/nihil/restore" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/voluptatem/forms/sed/statuses/vero/versions/nihil/restore"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/{company}/forms/{form}/statuses/{status}/versions/{version}/restore

URL Parameters

company  string  

form  string  

The form.

status  string  

The status.

version  string  

The version.

Form Statuses

Manage statuses attached to a form

GET api/{company}/forms/{form_id}/statuses

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/quia/forms/deserunt/statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quia/forms/deserunt/statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/forms/{form_id}/statuses

URL Parameters

company  string  

form_id  string  

The ID of the form.

POST api/{company}/forms/{form}/statuses

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/eligendi/forms/quae/statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"active\": true,
    \"default\": false,
    \"final\": false,
    \"icon\": \"xdrugmkbwtuseyzbhwekiigxoscrnoikelwkqeurrdyderkhrnmdsexnyicmnlzpjnwojlveskvpzchonskaidesubjobmiajcqiuxivnlkuuokupqpugbhwy\",
    \"translations\": {
        \"fr\": \"zvkdntwkcauoifbswrhsxtjspfkxmxtrgisfqeycztuehjjmeqrwinegiroubrwfqgdgvcvsezycgsizaysjghkaqtiyyebgocr\",
        \"en\": \"ootieiiklnfqcjvojosdwtwktcmpglrgkruavavpuonrhjlnmlynvpsnclcfwscxvpc\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/eligendi/forms/quae/statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "active": true,
    "default": false,
    "final": false,
    "icon": "xdrugmkbwtuseyzbhwekiigxoscrnoikelwkqeurrdyderkhrnmdsexnyicmnlzpjnwojlveskvpzchonskaidesubjobmiajcqiuxivnlkuuokupqpugbhwy",
    "translations": {
        "fr": "zvkdntwkcauoifbswrhsxtjspfkxmxtrgisfqeycztuehjjmeqrwinegiroubrwfqgdgvcvsezycgsizaysjghkaqtiyyebgocr",
        "en": "ootieiiklnfqcjvojosdwtwktcmpglrgkruavavpuonrhjlnmlynvpsnclcfwscxvpc"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/forms/{form}/statuses

URL Parameters

company  string  

form  string  

The form.

Body Parameters

active  boolean  

default  boolean  

final  boolean  

icon  string optional  

validation.max.

translations  object optional  

translations.fr  string  

validation.max.

translations.en  string optional  

validation.max.

PUT api/{company}/forms/{form_id}/statuses/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/iusto/forms/eligendi/statuses/modi" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"active\": true,
    \"default\": true,
    \"final\": false,
    \"icon\": \"ovyiscklbvoesvgosffzptwvkbrmxcmxaafiwitzpdzgyjhygmrtlmfahsiansoqkbosnbasiqlkcbekkcbnuysqxhuduapngcpkfixufhymqswxeoudjkywxmupbnxpjmrlznkqziuniimrzzygntxmdrzjwbatnzcluwnjzwdopgpaerxopgicnumyfithilkqjsruglahnigxzssswklrubrzmkdzc\",
    \"translations\": {
        \"fr\": \"hmcvccltgfabjblqxzakcogffoidus\",
        \"en\": \"bmqgoemxrvqikrhrrgeqez\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/iusto/forms/eligendi/statuses/modi"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "active": true,
    "default": true,
    "final": false,
    "icon": "ovyiscklbvoesvgosffzptwvkbrmxcmxaafiwitzpdzgyjhygmrtlmfahsiansoqkbosnbasiqlkcbekkcbnuysqxhuduapngcpkfixufhymqswxeoudjkywxmupbnxpjmrlznkqziuniimrzzygntxmdrzjwbatnzcluwnjzwdopgpaerxopgicnumyfithilkqjsruglahnigxzssswklrubrzmkdzc",
    "translations": {
        "fr": "hmcvccltgfabjblqxzakcogffoidus",
        "en": "bmqgoemxrvqikrhrrgeqez"
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/forms/{form_id}/statuses/{id}

PATCH api/{company}/forms/{form_id}/statuses/{id}

URL Parameters

company  string  

form_id  string  

The ID of the form.

id  string  

The ID of the status.

Body Parameters

active  boolean optional  

default  boolean optional  

final  boolean optional  

icon  string optional  

validation.max.

translations  object optional  

translations.fr  string optional  

validation.max.

translations.en  string optional  

validation.max.

Form Types

Manage form types for a company

GET api/{company}/form-types

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/nihil/form-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/nihil/form-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/form-types

URL Parameters

company  string  

POST api/{company}/form-types

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/voluptas/form-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"active\": false,
    \"purpose\": \"azksvsdpehkisgvuxkvuqt\",
    \"listable\": true,
    \"translations\": {
        \"fr\": {
            \"name\": \"sxsnekynfluxwqagkkxsldgozcirdsqugypiajrgrohjsujjyeskzgzrvvyhxmexzfymzippvnelvabbdhjorggshpzfymcjbaielndjqbkfllxehleiiasedlwlvmninjnzthyizjaqurwqvkrsywymbzgrlogmpptodeyebiihsvs\",
            \"description\": \"unde\"
        },
        \"en\": {
            \"name\": \"hnyvvzckkamnsspzgnftvlllnhaaanehrsycwzwchxdvxaobiycftavsdohfgibbeeddupcvcqnkzsxxdxkmglzbkctpbnctqoweulolsyjrvawnnqmekwzbsn\",
            \"description\": \"dignissimos\"
        }
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/voluptas/form-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "active": false,
    "purpose": "azksvsdpehkisgvuxkvuqt",
    "listable": true,
    "translations": {
        "fr": {
            "name": "sxsnekynfluxwqagkkxsldgozcirdsqugypiajrgrohjsujjyeskzgzrvvyhxmexzfymzippvnelvabbdhjorggshpzfymcjbaielndjqbkfllxehleiiasedlwlvmninjnzthyizjaqurwqvkrsywymbzgrlogmpptodeyebiihsvs",
            "description": "unde"
        },
        "en": {
            "name": "hnyvvzckkamnsspzgnftvlllnhaaanehrsycwzwchxdvxaobiycftavsdohfgibbeeddupcvcqnkzsxxdxkmglzbkctpbnctqoweulolsyjrvawnnqmekwzbsn",
            "description": "dignissimos"
        }
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/form-types

URL Parameters

company  string  

Body Parameters

active  boolean  

purpose  string optional  

validation.max.

listable  boolean optional  

translations  object optional  

translations.fr  object optional  

translations.fr.name  string  

validation.max.

translations.fr.description  string optional  

translations.en  object optional  

translations.en.name  string optional  

validation.max.

translations.en.description  string optional  

GET api/{company}/form-types/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/officia/form-types/qui" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/officia/form-types/qui"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/form-types/{id}

URL Parameters

company  string  

id  string  

The ID of the form type.

PUT api/{company}/form-types/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/vel/form-types/harum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"active\": true,
    \"purpose\": \"yuyynfrfspi\",
    \"listable\": true,
    \"translations\": {
        \"fr\": {
            \"name\": \"dilgrxafddlerqsdvlnitq\",
            \"description\": \"repellat\"
        },
        \"en\": {
            \"name\": \"jhckdzecthvqubdsdudhxbdphglfcjnkgazsu\",
            \"description\": \"quia\"
        }
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/vel/form-types/harum"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "active": true,
    "purpose": "yuyynfrfspi",
    "listable": true,
    "translations": {
        "fr": {
            "name": "dilgrxafddlerqsdvlnitq",
            "description": "repellat"
        },
        "en": {
            "name": "jhckdzecthvqubdsdudhxbdphglfcjnkgazsu",
            "description": "quia"
        }
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/form-types/{id}

PATCH api/{company}/form-types/{id}

URL Parameters

company  string  

id  string  

The ID of the form type.

Body Parameters

active  boolean optional  

purpose  string optional  

validation.max.

listable  boolean optional  

translations  object optional  

translations.fr  object optional  

translations.fr.name  string optional  

validation.max.

translations.fr.description  string optional  

translations.en  object optional  

translations.en.name  string optional  

validation.max.

translations.en.description  string optional  

DELETE api/{company}/form-types/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/quos/form-types/quis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quos/form-types/quis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/form-types/{id}

URL Parameters

company  string  

id  string  

The ID of the form type.

Form deployment applications

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/cum/forms/nihil/applications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/cum/forms/nihil/applications"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/forms/{form_id}/applications

URL Parameters

company  string  

form_id  string  

The ID of the form.

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/ad/forms/qui/applications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"App mobile Android v2\",
    \"source\": \"mobile\",
    \"lang\": \"fr\",
    \"active\": 1,
    \"client_url\": \"https:\\/\\/app.maville.fr\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/ad/forms/qui/applications"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "App mobile Android v2",
    "source": "mobile",
    "lang": "fr",
    "active": 1,
    "client_url": "https:\/\/app.maville.fr"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/forms/{form}/applications

URL Parameters

company  string  

form  string  

The form.

Body Parameters

name  string  

Nom du déploiement (ex. application mobile iOS). validation.max.

source  string  

Source du déploiement (mobile, web, kiosk…). validation.max.

lang  string  

Langue par défaut du formulaire (fr, en…). validation.max.

active  integer  

Statut actif : 1 = actif, 0 = inactif.

client_url  string  

URL du client front-end (deep link ou URL web). validation.max.

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/consequatur/forms/ducimus/applications/150132d0-f05b-1022-dd70-1ad04a03a000" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/consequatur/forms/ducimus/applications/150132d0-f05b-1022-dd70-1ad04a03a000"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/forms/{form_id}/applications/{id}

URL Parameters

company  string  

form_id  string  

The ID of the form.

id  string  

The ID of the application.

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/qui/forms/consequuntur/applications/150132d0-f05b-1022-dd70-1ad04a03a000" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"yhphgxhzlhhmtcmnxtmcysnzheeqxuqvxobhvxuqedilktnypugjwpypsmdmkgivdupiw\",
    \"source\": \"bgrdciimakwnaqyzjsypfgslpeziyampcqvcpzvehhsancyqcypwqyssowfplrenwnuxrwfbjj\",
    \"lang\": \"qsfcjmkaiycfgvyyzrutngeilulvazyduvucumwlrepirferihwugoknlkxsnrbaibrkbemiifrfrpszhqlpkduspzgezlwrqnaclncoqbqgshweevexenmmpfxdibnmrewhruqzvzowragaiaxpivtthmibiesizssepuhwruutfasdiftvuwsoocqjkllevmrjmxyqcwsjaxztadtesjflxoxea\",
    \"active\": 7,
    \"client_url\": \"fqgcmxkispiqweukzwxyhdpqgjjoowenoqtifvvkebafiexqrrhjsonvdeleooraahwwewricwq\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/qui/forms/consequuntur/applications/150132d0-f05b-1022-dd70-1ad04a03a000"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "yhphgxhzlhhmtcmnxtmcysnzheeqxuqvxobhvxuqedilktnypugjwpypsmdmkgivdupiw",
    "source": "bgrdciimakwnaqyzjsypfgslpeziyampcqvcpzvehhsancyqcypwqyssowfplrenwnuxrwfbjj",
    "lang": "qsfcjmkaiycfgvyyzrutngeilulvazyduvucumwlrepirferihwugoknlkxsnrbaibrkbemiifrfrpszhqlpkduspzgezlwrqnaclncoqbqgshweevexenmmpfxdibnmrewhruqzvzowragaiaxpivtthmibiesizssepuhwruutfasdiftvuwsoocqjkllevmrjmxyqcwsjaxztadtesjflxoxea",
    "active": 7,
    "client_url": "fqgcmxkispiqweukzwxyhdpqgjjoowenoqtifvvkebafiexqrrhjsonvdeleooraahwwewricwq"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/forms/{form_id}/applications/{id}

PATCH api/{company}/forms/{form_id}/applications/{id}

URL Parameters

company  string  

form_id  string  

The ID of the form.

id  string  

The ID of the application.

Body Parameters

name  string  

validation.max.

source  string  

validation.max.

lang  string  

validation.max.

active  integer  

client_url  string  

validation.max.

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/rem/forms/debitis/applications/150132d0-f05b-1022-dd70-1ad04a03a000" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/rem/forms/debitis/applications/150132d0-f05b-1022-dd70-1ad04a03a000"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/forms/{form_id}/applications/{id}

URL Parameters

company  string  

form_id  string  

The ID of the form.

id  string  

The ID of the application.

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/quia/forms/doloribus/applications/150132d0-f05b-1022-dd70-1ad04a03a000/download" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quia/forms/doloribus/applications/150132d0-f05b-1022-dd70-1ad04a03a000/download"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/forms/{id}/applications/{application_uuid}/download

URL Parameters

company  string  

id  string  

The ID of the form.

application_uuid  string  

Global News (Superadmin)

Gestion des actualités globales visibles par toutes les municipalités.

GET api/superadmin/news

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/superadmin/news" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/superadmin/news

POST api/superadmin/news

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/superadmin/news" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"news_category_id\": 3,
    \"cover_media_id\": 12,
    \"fr\": {
        \"title\": \"Travaux rue de la Paix\",
        \"content\": \"<p>Les travaux débuteront le 10 juin...<\\/p>\"
    },
    \"en\": {
        \"title\": \"Works on Rue de la Paix\",
        \"content\": \"neque\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "news_category_id": 3,
    "cover_media_id": 12,
    "fr": {
        "title": "Travaux rue de la Paix",
        "content": "<p>Les travaux débuteront le 10 juin...<\/p>"
    },
    "en": {
        "title": "Works on Rue de la Paix",
        "content": "neque"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/superadmin/news

Body Parameters

news_category_id  integer optional  

ID de la catégorie d'actualité (optionnel).

cover_media_id  integer optional  

ID du média de couverture (optionnel).

fr  object optional  

fr.title  string  

Titre de l'article en français. validation.max.

fr.content  string optional  

Contenu de l'article en français (HTML ou Markdown).

en  object optional  

en.title  string optional  

Titre en anglais (optionnel). validation.max.

en.content  string optional  

Contenu en anglais (optionnel).

GET api/superadmin/news/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/superadmin/news/nam" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news/nam"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/superadmin/news/{id}

URL Parameters

id  string  

The ID of the news.

PUT api/superadmin/news/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/superadmin/news/veniam" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"news_category_id\": 14,
    \"cover_media_id\": 2,
    \"fr\": {
        \"title\": \"hrtzdweirdhlzhfaeszepzhfknbumrjimuhqlnchcsanuqzxoaryqrfsyvkwrbyrbukznswwjvmhhzcqmdqnrijbjpjozgxcudrbnqnzhonakqbommzaayzeocddorrmeksxfzqmcgtkpndqqqponfaqacqfugwhdeuydckyhrdxsems\",
        \"content\": \"enim\"
    },
    \"en\": {
        \"title\": \"zhiqtaumuikkiuhaimaseslmlrdedzavpfzntupqgjcwftnbickwdxrgjbuopnzxgeycvwhnypxkludrwptmeqaimrirlkvqqxrrjvsjeirdasghiaunmvnfttyemaaljpmdkguosuogytptkezlqpkcwgsuzyaipqurizcivusboyhalg\",
        \"content\": \"et\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news/veniam"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "news_category_id": 14,
    "cover_media_id": 2,
    "fr": {
        "title": "hrtzdweirdhlzhfaeszepzhfknbumrjimuhqlnchcsanuqzxoaryqrfsyvkwrbyrbukznswwjvmhhzcqmdqnrijbjpjozgxcudrbnqnzhonakqbommzaayzeocddorrmeksxfzqmcgtkpndqqqponfaqacqfugwhdeuydckyhrdxsems",
        "content": "enim"
    },
    "en": {
        "title": "zhiqtaumuikkiuhaimaseslmlrdedzavpfzntupqgjcwftnbickwdxrgjbuopnzxgeycvwhnypxkludrwptmeqaimrirlkvqqxrrjvsjeirdasghiaunmvnfttyemaaljpmdkguosuogytptkezlqpkcwgsuzyaipqurizcivusboyhalg",
        "content": "et"
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/superadmin/news/{id}

URL Parameters

id  string  

The ID of the news.

Body Parameters

news_category_id  integer optional  

cover_media_id  integer optional  

fr  object optional  

fr.title  string  

validation.max.

fr.content  string optional  

en  object optional  

en.title  string optional  

validation.max.

en.content  string optional  

DELETE api/superadmin/news/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/superadmin/news/aliquid" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news/aliquid"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/superadmin/news/{id}

URL Parameters

id  string  

The ID of the news.

PUT api/superadmin/news/{id}/publish

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/superadmin/news/rerum/publish" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news/rerum/publish"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/superadmin/news/{id}/publish

URL Parameters

id  string  

The ID of the news.

PUT api/superadmin/news/{id}/unpublish

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/superadmin/news/non/unpublish" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news/non/unpublish"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/superadmin/news/{id}/unpublish

URL Parameters

id  string  

The ID of the news.

GET api/superadmin/news-categories

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/superadmin/news-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/superadmin/news-categories

POST api/superadmin/news-categories

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/superadmin/news-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"active\": true,
    \"fr\": {
        \"name\": \"kjidbrtbdxzvldkwvhhhbobpmflvwyeenkiudsqgjlffjjleaxrcuswnogsibrzdgmtzcguhnqnsffvkhykwynyvyodnlrfbjgzlqlucflbnyrjuflnapabiaiftuyuhinswzyunezuhwqh\"
    },
    \"en\": {
        \"name\": \"rutzkusccwozbiiwdthclyheyquotooputxwtiladmtgawfzbgyloahgyrtpqivoykiwvkpivvnlk\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "active": true,
    "fr": {
        "name": "kjidbrtbdxzvldkwvhhhbobpmflvwyeenkiudsqgjlffjjleaxrcuswnogsibrzdgmtzcguhnqnsffvkhykwynyvyodnlrfbjgzlqlucflbnyrjuflnapabiaiftuyuhinswzyunezuhwqh"
    },
    "en": {
        "name": "rutzkusccwozbiiwdthclyheyquotooputxwtiladmtgawfzbgyloahgyrtpqivoykiwvkpivvnlk"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/superadmin/news-categories

Body Parameters

active  boolean optional  

fr  object optional  

fr.name  string  

validation.max.

en  object optional  

en.name  string optional  

validation.max.

PUT api/superadmin/news-categories/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/superadmin/news-categories/laudantium" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"active\": false,
    \"fr\": {
        \"name\": \"oaoacrryilmwshtgayzgxxziknnzkhmruvjmknvweqvmrjlhfysuujmdznzdqzqkuobvrloruprqkxsib\"
    },
    \"en\": {
        \"name\": \"zrvsyytlhoqjepgsznnghcojyyfwzzvfypicvkwmtqhiiyxunjltawqlezcwsniqoxtxcssboujelyxfgqvhtddutikcqkjmdipkriwqglxkuwrgpksjjcswqxmzluvefflflmgeebkvtbzotvjrehyndixrglmcykcbkachezyxcozn\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news-categories/laudantium"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "active": false,
    "fr": {
        "name": "oaoacrryilmwshtgayzgxxziknnzkhmruvjmknvweqvmrjlhfysuujmdznzdqzqkuobvrloruprqkxsib"
    },
    "en": {
        "name": "zrvsyytlhoqjepgsznnghcojyyfwzzvfypicvkwmtqhiiyxunjltawqlezcwsniqoxtxcssboujelyxfgqvhtddutikcqkjmdipkriwqglxkuwrgpksjjcswqxmzluvefflflmgeebkvtbzotvjrehyndixrglmcykcbkachezyxcozn"
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/superadmin/news-categories/{id}

URL Parameters

id  string  

The ID of the news category.

Body Parameters

active  boolean optional  

fr  object optional  

fr.name  string  

validation.max.

en  object optional  

en.name  string optional  

validation.max.

DELETE api/superadmin/news-categories/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/superadmin/news-categories/consequuntur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/superadmin/news-categories/consequuntur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/superadmin/news-categories/{id}

URL Parameters

id  string  

The ID of the news category.

Global News Public

Consultation publique des actualités globales (toutes municipalités confondues).

GET api/public/news

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/public/news" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/public/news"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 996
vary: Origin
 

{
    "articles": {
        "current_page": 1,
        "data": [],
        "first_page_url": "https://api.demo.bouge.io/api/public/news?page=1",
        "from": null,
        "last_page": 1,
        "last_page_url": "https://api.demo.bouge.io/api/public/news?page=1",
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://api.demo.bouge.io/api/public/news?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://api.demo.bouge.io/api/public/news",
        "per_page": 25,
        "prev_page_url": null,
        "to": null,
        "total": 0
    }
}
 

Request      

GET api/public/news

GET api/public/news/{articleSlug}

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/public/news/a" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/public/news/a"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 995
vary: Origin
 

{
    "message": "No query results for model [App\\Models\\News\\NewsArticle].",
    "exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
    "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
    "line": 391,
    "trace": [
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
            "line": 367,
            "function": "prepareException",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/app/Exceptions/Handler.php",
            "line": 48,
            "function": "render",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/nunomaduro/collision/src/Adapters/Laravel/ExceptionHandler.php",
            "line": 54,
            "function": "render",
            "class": "App\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php",
            "line": 51,
            "function": "render",
            "class": "NunoMaduro\\Collision\\Adapters\\Laravel\\ExceptionHandler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 143,
            "function": "handleException",
            "class": "Illuminate\\Routing\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php",
            "line": 50,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 126,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 92,
            "function": "handleRequest",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 54,
            "function": "handleRequestUsingNamedLimiter",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 797,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 190,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Foundation\\Http\\Kernel::dispatchToRouter():187}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestIpMiddleware.php",
            "line": 45,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestIpMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestMiddleware.php",
            "line": 31,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/fruitcake/laravel-cors/src/HandleCors.php",
            "line": 52,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 39,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 165,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 134,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 176,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 41,
            "function": "{closure:Illuminate\\Container\\BoundMethod::call():35}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 661,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 183,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Command/Command.php",
            "line": 326,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 152,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 1098,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 324,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 175,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Application.php",
            "line": 102,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 155,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/artisan",
            "line": 35,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}
 

Request      

GET api/public/news/{articleSlug}

URL Parameters

articleSlug  string  

News

Backoffice news articles management

GET api/{company}/news

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/consequuntur/news" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/consequuntur/news"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/news

URL Parameters

company  string  

POST api/{company}/news

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/ut/news" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"news_category_id\": 3,
    \"cover_media_id\": 12,
    \"fr\": {
        \"title\": \"Travaux rue de la Paix\",
        \"content\": \"<p>Les travaux débuteront le 10 juin...<\\/p>\"
    },
    \"en\": {
        \"title\": \"Works on Rue de la Paix\",
        \"content\": \"dolor\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/ut/news"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "news_category_id": 3,
    "cover_media_id": 12,
    "fr": {
        "title": "Travaux rue de la Paix",
        "content": "<p>Les travaux débuteront le 10 juin...<\/p>"
    },
    "en": {
        "title": "Works on Rue de la Paix",
        "content": "dolor"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/news

URL Parameters

company  string  

Body Parameters

news_category_id  integer optional  

ID de la catégorie d'actualité (optionnel).

cover_media_id  integer optional  

ID du média de couverture (optionnel).

fr  object optional  

fr.title  string  

Titre de l'article en français. validation.max.

fr.content  string optional  

Contenu de l'article en français (HTML ou Markdown).

en  object optional  

en.title  string optional  

Titre en anglais (optionnel). validation.max.

en.content  string optional  

Contenu en anglais (optionnel).

GET api/{company}/news/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/nesciunt/news/autem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/nesciunt/news/autem"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/news/{id}

URL Parameters

company  string  

id  string  

The ID of the news.

PUT api/{company}/news/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/a/news/et" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"news_category_id\": 2,
    \"cover_media_id\": 14,
    \"fr\": {
        \"title\": \"adoxelyqketjatmtojuxgbcmnsdgigtadxawdwhbvmjtxjjtvxrtpahphdxzkpcdwowpseyemfdvmkdhlrvgysdiwuqqnhyuhgfinnazflpvrknbacimqqoyjawesvpmuvjvnsqwbkrodpjqhgcreqyuuasqvbottyduopfwdhvktpxxfzrxghaywazfrbsilumcqpiyvzaxttddmrwwkxdqwaxdqvtgiioeyykgzuwidpwmdmp\",
        \"content\": \"molestias\"
    },
    \"en\": {
        \"title\": \"sbamohvcvjhzjdxeelcpjkkintmjyakyvzqjsecnfovlv\",
        \"content\": \"reiciendis\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/a/news/et"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "news_category_id": 2,
    "cover_media_id": 14,
    "fr": {
        "title": "adoxelyqketjatmtojuxgbcmnsdgigtadxawdwhbvmjtxjjtvxrtpahphdxzkpcdwowpseyemfdvmkdhlrvgysdiwuqqnhyuhgfinnazflpvrknbacimqqoyjawesvpmuvjvnsqwbkrodpjqhgcreqyuuasqvbottyduopfwdhvktpxxfzrxghaywazfrbsilumcqpiyvzaxttddmrwwkxdqwaxdqvtgiioeyykgzuwidpwmdmp",
        "content": "molestias"
    },
    "en": {
        "title": "sbamohvcvjhzjdxeelcpjkkintmjyakyvzqjsecnfovlv",
        "content": "reiciendis"
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/news/{id}

URL Parameters

company  string  

id  string  

The ID of the news.

Body Parameters

news_category_id  integer optional  

cover_media_id  integer optional  

fr  object optional  

fr.title  string  

validation.max.

fr.content  string optional  

en  object optional  

en.title  string optional  

validation.max.

en.content  string optional  

DELETE api/{company}/news/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/sunt/news/at" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/sunt/news/at"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/news/{id}

URL Parameters

company  string  

id  string  

The ID of the news.

PUT api/{company}/news/{id}/publish

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/et/news/pariatur/publish" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/et/news/pariatur/publish"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/{company}/news/{id}/publish

URL Parameters

company  string  

id  string  

The ID of the news.

PUT api/{company}/news/{id}/unpublish

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/aliquam/news/et/unpublish" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/aliquam/news/et/unpublish"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/{company}/news/{id}/unpublish

URL Parameters

company  string  

id  string  

The ID of the news.

GET api/{company}/news-categories

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/sit/news-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/sit/news-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/news-categories

URL Parameters

company  string  

POST api/{company}/news-categories

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/vero/news-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"active\": true,
    \"fr\": {
        \"name\": \"amknqvrpeqhmbaeqhhdxsvqtqbesulojbtaoaqdqexdhbpbympliutkxpgjteudubsibgpfvlgdpyaloowazngkpvzzsvgbckauldboihjthtxfjctjamlcclmcryoodiojlvjpduwyqetchcmzgthppyrabllnzzwnnshntymufwjxuorawrkcabmmdzqnfdtydubkvcsxbajazufkb\"
    },
    \"en\": {
        \"name\": \"npsbpegykpmnrdavxnxqowpgxecidfkfcltifpaylihwmfkvbhoyfwwagokaltxjabrvtmtxwcwqfxqofwgtwsaupdbnereisifdtzgubkauwywvekncchlswoevpdorpdzdjnqexlunocwcvckjdizcpekmynplevitpwynxmycwoywalgbqpkhafjfuvdgvlbcktaqyrcudhhgvegrtrcngsfcmefqdhzkvjcfnwhs\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/vero/news-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "active": true,
    "fr": {
        "name": "amknqvrpeqhmbaeqhhdxsvqtqbesulojbtaoaqdqexdhbpbympliutkxpgjteudubsibgpfvlgdpyaloowazngkpvzzsvgbckauldboihjthtxfjctjamlcclmcryoodiojlvjpduwyqetchcmzgthppyrabllnzzwnnshntymufwjxuorawrkcabmmdzqnfdtydubkvcsxbajazufkb"
    },
    "en": {
        "name": "npsbpegykpmnrdavxnxqowpgxecidfkfcltifpaylihwmfkvbhoyfwwagokaltxjabrvtmtxwcwqfxqofwgtwsaupdbnereisifdtzgubkauwywvekncchlswoevpdorpdzdjnqexlunocwcvckjdizcpekmynplevitpwynxmycwoywalgbqpkhafjfuvdgvlbcktaqyrcudhhgvegrtrcngsfcmefqdhzkvjcfnwhs"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/news-categories

URL Parameters

company  string  

Body Parameters

active  boolean optional  

fr  object optional  

fr.name  string  

validation.max.

en  object optional  

en.name  string optional  

validation.max.

PUT api/{company}/news-categories/{id}

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/nihil/news-categories/quasi" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"active\": false,
    \"fr\": {
        \"name\": \"qegnsajppsmkssithiznfdjwvuzeunuiq\"
    },
    \"en\": {
        \"name\": \"xivasdvakajobxroklbqcpdlmkvvrqqcymhommbmhlaiqigfqnwcslvrtgzfndwiduhqoclgbzmpgycfinsfgridwanfkeorrhnuevgf\"
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/nihil/news-categories/quasi"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "active": false,
    "fr": {
        "name": "qegnsajppsmkssithiznfdjwvuzeunuiq"
    },
    "en": {
        "name": "xivasdvakajobxroklbqcpdlmkvvrqqcymhommbmhlaiqigfqnwcslvrtgzfndwiduhqoclgbzmpgycfinsfgridwanfkeorrhnuevgf"
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/news-categories/{id}

URL Parameters

company  string  

id  string  

The ID of the news category.

Body Parameters

active  boolean optional  

fr  object optional  

fr.name  string  

validation.max.

en  object optional  

en.name  string optional  

validation.max.

DELETE api/{company}/news-categories/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/nihil/news-categories/similique" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/nihil/news-categories/similique"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/news-categories/{id}

URL Parameters

company  string  

id  string  

The ID of the news category.

News Public

Consultation publique des articles d'actualité par UUID de municipalité.

List published news articles for a company.

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/public/550e8400-e29b-41d4-a716-446655440000/news" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/public/550e8400-e29b-41d4-a716-446655440000/news"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 994
vary: Origin
 

{
    "message": "No query results for model [App\\Models\\Company].",
    "exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
    "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
    "line": 391,
    "trace": [
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
            "line": 367,
            "function": "prepareException",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/app/Exceptions/Handler.php",
            "line": 48,
            "function": "render",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/nunomaduro/collision/src/Adapters/Laravel/ExceptionHandler.php",
            "line": 54,
            "function": "render",
            "class": "App\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php",
            "line": 51,
            "function": "render",
            "class": "NunoMaduro\\Collision\\Adapters\\Laravel\\ExceptionHandler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 143,
            "function": "handleException",
            "class": "Illuminate\\Routing\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php",
            "line": 50,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 126,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 92,
            "function": "handleRequest",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 54,
            "function": "handleRequestUsingNamedLimiter",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 797,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 190,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Foundation\\Http\\Kernel::dispatchToRouter():187}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestIpMiddleware.php",
            "line": 45,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestIpMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestMiddleware.php",
            "line": 31,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/fruitcake/laravel-cors/src/HandleCors.php",
            "line": 52,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 39,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 165,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 134,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 176,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 41,
            "function": "{closure:Illuminate\\Container\\BoundMethod::call():35}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 661,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 183,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Command/Command.php",
            "line": 326,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 152,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 1098,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 324,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 175,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Application.php",
            "line": 102,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 155,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/artisan",
            "line": 35,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}
 

Request      

GET api/public/{companyUuid}/news

URL Parameters

companyUuid  string  

The UUID of the company.

Show a published news article for a company.

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/public/550e8400-e29b-41d4-a716-446655440000/news/mon-article" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/public/550e8400-e29b-41d4-a716-446655440000/news/mon-article"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 993
vary: Origin
 

{
    "message": "No query results for model [App\\Models\\Company].",
    "exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
    "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
    "line": 391,
    "trace": [
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
            "line": 367,
            "function": "prepareException",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/app/Exceptions/Handler.php",
            "line": 48,
            "function": "render",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/nunomaduro/collision/src/Adapters/Laravel/ExceptionHandler.php",
            "line": 54,
            "function": "render",
            "class": "App\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php",
            "line": 51,
            "function": "render",
            "class": "NunoMaduro\\Collision\\Adapters\\Laravel\\ExceptionHandler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 143,
            "function": "handleException",
            "class": "Illuminate\\Routing\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php",
            "line": 50,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 126,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 92,
            "function": "handleRequest",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 54,
            "function": "handleRequestUsingNamedLimiter",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 797,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 190,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Foundation\\Http\\Kernel::dispatchToRouter():187}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestIpMiddleware.php",
            "line": 45,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestIpMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestMiddleware.php",
            "line": 31,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/fruitcake/laravel-cors/src/HandleCors.php",
            "line": 52,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 39,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 165,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 134,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 176,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 41,
            "function": "{closure:Illuminate\\Container\\BoundMethod::call():35}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 661,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 183,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Command/Command.php",
            "line": 326,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 152,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 1098,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 324,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 175,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Application.php",
            "line": 102,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 155,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/artisan",
            "line": 35,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}
 

Request      

GET api/public/{companyUuid}/news/{articleSlug}

URL Parameters

companyUuid  string  

The UUID of the company.

articleSlug  string  

The slug of the article.

Notifications

Préférences de notifications par utilisateur.

Update notification preferences for a user

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/rerum/notification-preferences/16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"preferences\": [
        {
            \"channels\": [
                \"sit\"
            ]
        }
    ]
}"
const url = new URL(
    "https://api.demo.bouge.io/api/rerum/notification-preferences/16"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "preferences": [
        {
            "channels": [
                "sit"
            ]
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/notification-preferences/{user}

URL Parameters

company  string  

user  integer  

Body Parameters

preferences  object[] optional  

preferences[].event  string optional  

preferences[].channels  string[]  

GET api/{company}/users/me/notifications

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/quia/users/me/notifications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quia/users/me/notifications"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/users/me/notifications

URL Parameters

company  string  

POST api/{company}/users/me/notifications/read-all

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/aspernatur/users/me/notifications/read-all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/aspernatur/users/me/notifications/read-all"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/{company}/users/me/notifications/read-all

URL Parameters

company  string  

POST api/{company}/users/me/notifications/{id}/read

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/laudantium/users/me/notifications/iusto/read" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/laudantium/users/me/notifications/iusto/read"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/{company}/users/me/notifications/{id}/read

URL Parameters

company  string  

id  string  

The ID of the notification.

Post

Get recent and active posts from user's company to show on the dashboard

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/eveniet/posts/dashboard" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/eveniet/posts/dashboard"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/dashboard

URL Parameters

company  string  

Get posts where current user is operator

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/quibusdam/posts/dashboard/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quibusdam/posts/dashboard/user"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/dashboard/user

URL Parameters

company  string  

Display filters' post

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/sed/posts/filters" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/sed/posts/filters"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/filters

URL Parameters

company  string  

Get posts by statuses

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/velit/posts/statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/velit/posts/statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/statuses

URL Parameters

company  string  

GET api/{company}/posts/exports

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/dicta/posts/exports" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/dicta/posts/exports"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/exports

URL Parameters

company  string  

Send operator reminder

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/dolorem/posts/1/remind" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/dolorem/posts/1/remind"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/{company}/posts/{post_id}/remind

URL Parameters

company  string  

post_id  integer  

The ID of the post.

POST api/{company}/posts/{postId}/export/pdf

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/quas/posts/sapiente/export/pdf" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quas/posts/sapiente/export/pdf"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/{company}/posts/{postId}/export/pdf

URL Parameters

company  string  

postId  string  

Update post priority

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/saepe/posts/ipsum/priority/minima" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"postId\": 0,
    \"priority\": 2
}"
const url = new URL(
    "https://api.demo.bouge.io/api/saepe/posts/ipsum/priority/minima"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "postId": 0,
    "priority": 2
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/posts/{postId}/priority/{priority}

URL Parameters

company  string  

postId  string  

priority  string  

The priority.

Body Parameters

postId  integer  

validation.min.

priority  integer  

validation.min validation.max.

GET api/{company}/location/{location}/restricted/{restrict}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/explicabo/location/accusantium/restricted/ad" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/explicabo/location/accusantium/restricted/ad"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Cannot assign null to property App\\Services\\Map\\BingService::$key of type string",
    "exception": "TypeError",
    "file": "/var/www/clients/client0/web1/web/crm/releases/124/app/Services/Map/BingService.php",
    "line": 18,
    "trace": [
        {
            "function": "__construct",
            "class": "App\\Services\\Map\\BingService",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 929,
            "function": "newInstanceArgs",
            "class": "ReflectionClass",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 770,
            "function": "build",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 881,
            "function": "resolve",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 706,
            "function": "resolve",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 866,
            "function": "make",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 1043,
            "function": "make",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 959,
            "function": "resolveClass",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 920,
            "function": "resolveDependencies",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 770,
            "function": "build",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 881,
            "function": "resolve",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 706,
            "function": "resolve",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 866,
            "function": "make",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 274,
            "function": "make",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 1099,
            "function": "getController",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 1030,
            "function": "controllerMiddleware",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 810,
            "function": "gatherMiddleware",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 792,
            "function": "gatherRouteMiddleware",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 190,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Foundation\\Http\\Kernel::dispatchToRouter():187}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestIpMiddleware.php",
            "line": 45,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestIpMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestMiddleware.php",
            "line": 31,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/fruitcake/laravel-cors/src/HandleCors.php",
            "line": 52,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 39,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 165,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 134,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 176,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 41,
            "function": "{closure:Illuminate\\Container\\BoundMethod::call():35}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 661,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 183,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Command/Command.php",
            "line": 326,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 152,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 1098,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 324,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 175,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Application.php",
            "line": 102,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 155,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/artisan",
            "line": 35,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}
 

Request      

GET api/{company}/location/{location}/restricted/{restrict}

URL Parameters

company  string  

location  string  

The location.

restrict  string  

GET api/{company}/location/{location}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/eligendi/location/et" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/eligendi/location/et"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Cannot assign null to property App\\Services\\Map\\BingService::$key of type string",
    "exception": "TypeError",
    "file": "/var/www/clients/client0/web1/web/crm/releases/124/app/Services/Map/BingService.php",
    "line": 18,
    "trace": [
        {
            "function": "__construct",
            "class": "App\\Services\\Map\\BingService",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 929,
            "function": "newInstanceArgs",
            "class": "ReflectionClass",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 770,
            "function": "build",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 881,
            "function": "resolve",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 706,
            "function": "resolve",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 866,
            "function": "make",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 1043,
            "function": "make",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 959,
            "function": "resolveClass",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 920,
            "function": "resolveDependencies",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 770,
            "function": "build",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 881,
            "function": "resolve",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 706,
            "function": "resolve",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 866,
            "function": "make",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 274,
            "function": "make",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 1099,
            "function": "getController",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 1030,
            "function": "controllerMiddleware",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 810,
            "function": "gatherMiddleware",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 792,
            "function": "gatherRouteMiddleware",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 190,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Foundation\\Http\\Kernel::dispatchToRouter():187}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestIpMiddleware.php",
            "line": 45,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestIpMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestMiddleware.php",
            "line": 31,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/fruitcake/laravel-cors/src/HandleCors.php",
            "line": 52,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 39,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 165,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 134,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 176,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 41,
            "function": "{closure:Illuminate\\Container\\BoundMethod::call():35}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 661,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 183,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Command/Command.php",
            "line": 326,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 152,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 1098,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 324,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 175,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Application.php",
            "line": 102,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 155,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/artisan",
            "line": 35,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}
 

Request      

GET api/{company}/location/{location}

URL Parameters

company  string  

location  string  

The location.

GET api/{company}/location/coordinates/{lat}/{lon}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/enim/location/coordinates/autem/omnis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/enim/location/coordinates/autem/omnis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Cannot assign null to property App\\Services\\Map\\BingService::$key of type string",
    "exception": "TypeError",
    "file": "/var/www/clients/client0/web1/web/crm/releases/124/app/Services/Map/BingService.php",
    "line": 18,
    "trace": [
        {
            "function": "__construct",
            "class": "App\\Services\\Map\\BingService",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 929,
            "function": "newInstanceArgs",
            "class": "ReflectionClass",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 770,
            "function": "build",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 881,
            "function": "resolve",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 706,
            "function": "resolve",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 866,
            "function": "make",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 1043,
            "function": "make",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 959,
            "function": "resolveClass",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 920,
            "function": "resolveDependencies",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 770,
            "function": "build",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 881,
            "function": "resolve",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 706,
            "function": "resolve",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 866,
            "function": "make",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 274,
            "function": "make",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 1099,
            "function": "getController",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 1030,
            "function": "controllerMiddleware",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 810,
            "function": "gatherMiddleware",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 792,
            "function": "gatherRouteMiddleware",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 190,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Foundation\\Http\\Kernel::dispatchToRouter():187}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestIpMiddleware.php",
            "line": 45,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestIpMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestMiddleware.php",
            "line": 31,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/fruitcake/laravel-cors/src/HandleCors.php",
            "line": 52,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 39,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 165,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 134,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 176,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 41,
            "function": "{closure:Illuminate\\Container\\BoundMethod::call():35}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 661,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 183,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Command/Command.php",
            "line": 326,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 152,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 1098,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 324,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 175,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Application.php",
            "line": 102,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 155,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/artisan",
            "line": 35,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}
 

Request      

GET api/{company}/location/coordinates/{lat}/{lon}

URL Parameters

company  string  

lat  string  

lon  string  

List posts

requires authentication

Retourne la liste paginée des signalements de la company.

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/molestias/posts?search=voirie" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/molestias/posts"
);

const params = {
    "search": "voirie",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "posts": {
        "current_page": 1,
        "data": [
            {
                "id": 101,
                "reference": "2024-00101",
                "title": "Nid de poule rue des Acacias",
                "priority": 2,
                "status_id": 5,
                "created_at": "2024-06-01T10:00:00.000000Z"
            }
        ],
        "per_page": 25,
        "total": 142
    }
}
 

Request      

GET api/{company}/posts

URL Parameters

company  string  

Query Parameters

search  string optional  

Recherche fulltext dans les signalements.

Create a post

requires authentication

Crée un nouveau signalement depuis le backoffice CRM.

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/error/posts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/error/posts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "post": {
        "id": 102,
        "reference": "2024-00102",
        "title": "Lampadaire hors service",
        "status_id": 1,
        "priority": 1,
        "created_at": "2024-06-02T09:00:00.000000Z"
    }
}
 

Example response (422, Validation error):


{
    "errors": {
        "form_id": [
            "The form id field is required."
        ]
    }
}
 

Request      

POST api/{company}/posts

URL Parameters

company  string  

Get a post

requires authentication

Retourne le détail d'un signalement avec son historique et les statuts disponibles.

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/adipisci/posts/aliquid" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/adipisci/posts/aliquid"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "post": {
        "id": 101,
        "reference": "2024-00101",
        "title": "Nid de poule rue des Acacias",
        "content": "Gros nid de poule dangereux...",
        "priority": 2,
        "status_id": 5,
        "author_email": "citoyen@example.com",
        "created_at": "2024-06-01T10:00:00.000000Z"
    },
    "history": [],
    "statuses": []
}
 

Example response (404):


{
    "message": "No query results for model [App\\Models\\Post\\Post]"
}
 

Request      

GET api/{company}/posts/{id}

URL Parameters

company  string  

id  string  

The ID of the post.

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/quo/posts/est" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quo/posts/est"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/{company}/posts/{id}

PATCH api/{company}/posts/{id}

URL Parameters

company  string  

id  string  

The ID of the post.

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/velit/posts/veritatis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/velit/posts/veritatis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/posts/{id}

URL Parameters

company  string  

id  string  

The ID of the post.

Post Comments

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/ut/posts/temporibus/comments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/ut/posts/temporibus/comments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/{post_id}/comments

URL Parameters

company  string  

post_id  string  

The ID of the post.

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/non/posts/totam/comments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message\": {
        \"mentions\": [
            17
        ]
    }
}"
const url = new URL(
    "https://api.demo.bouge.io/api/non/posts/totam/comments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message": {
        "mentions": [
            17
        ]
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/posts/{post}/comments

URL Parameters

company  string  

post  string  

The post.

Body Parameters

message  object optional  

message.mentions  integer[] optional  

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/nihil/posts/ad/comments/accusamus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/nihil/posts/ad/comments/accusamus"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/{post_id}/comments/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the comment.

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/eaque/posts/distinctio/comments/sit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/eaque/posts/distinctio/comments/sit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/{company}/posts/{post_id}/comments/{id}

PATCH api/{company}/posts/{post_id}/comments/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the comment.

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/sit/posts/inventore/comments/deserunt" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/sit/posts/inventore/comments/deserunt"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/posts/{post_id}/comments/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the comment.

Post Histories

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/sint/posts/et/histories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/sint/posts/et/histories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/{post_id}/histories

URL Parameters

company  string  

post_id  string  

The ID of the post.

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/at/posts/quo/histories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/at/posts/quo/histories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/{company}/posts/{post}/histories

URL Parameters

company  string  

post  string  

The post.

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/iusto/posts/et/histories/aut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/iusto/posts/et/histories/aut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/{post_id}/histories/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the history.

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/officia/posts/maiores/histories/laborum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/officia/posts/maiores/histories/laborum"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/{company}/posts/{post_id}/histories/{id}

PATCH api/{company}/posts/{post_id}/histories/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the history.

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/iste/posts/aut/histories/quae" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/iste/posts/aut/histories/quae"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/posts/{post_id}/histories/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the history.

Post Messages

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/quia/posts/est/messages" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quia/posts/est/messages"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/{post_id}/messages

URL Parameters

company  string  

post_id  string  

The ID of the post.

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/doloremque/posts/quisquam/messages" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"ipsa\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/doloremque/posts/quisquam/messages"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "content": "ipsa"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/posts/{post}/messages

URL Parameters

company  string  

post  string  

The post.

Body Parameters

content  string  

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/autem/posts/labore/messages/tenetur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/autem/posts/labore/messages/tenetur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/{post_id}/messages/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the message.

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/sunt/posts/nobis/messages/voluptatem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/sunt/posts/nobis/messages/voluptatem"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/{company}/posts/{post_id}/messages/{id}

PATCH api/{company}/posts/{post_id}/messages/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the message.

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/repellat/posts/pariatur/messages/aut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/repellat/posts/pariatur/messages/aut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/posts/{post_id}/messages/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the message.

Post RACI

Gestion des assignations RACI (Responsible, Accountable, Consulted, Informed) sur les signalements.

GET api/{company}/posts/{post_id}/racis

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/pariatur/posts/eaque/racis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/pariatur/posts/eaque/racis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/{post_id}/racis

URL Parameters

company  string  

post_id  string  

The ID of the post.

POST api/{company}/posts/{post}/racis

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/consequatur/posts/adipisci/racis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"racis\": [
        {
            \"id\": 1,
            \"is_responsible\": false,
            \"is_accountable\": false,
            \"is_consulted\": true,
            \"is_informed\": false
        }
    ]
}"
const url = new URL(
    "https://api.demo.bouge.io/api/consequatur/posts/adipisci/racis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "racis": [
        {
            "id": 1,
            "is_responsible": false,
            "is_accountable": false,
            "is_consulted": true,
            "is_informed": false
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/posts/{post}/racis

URL Parameters

company  string  

post  string  

The post.

Body Parameters

racis  object[] optional  

racis[].id  integer  

validation.min.

racis[].is_responsible  boolean  

racis[].is_accountable  boolean  

racis[].is_consulted  boolean  

racis[].is_informed  boolean  

GET api/{company}/posts/{post_id}/racis/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/officiis/posts/et/racis/aspernatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/officiis/posts/et/racis/aspernatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/{post_id}/racis/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the raci.

Post Statuses

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/assumenda/statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/assumenda/statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/statuses

URL Parameters

company  string  

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/consequuntur/posts/quia/statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/consequuntur/posts/quia/statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/{post_id}/statuses

URL Parameters

company  string  

post_id  string  

The ID of the post.

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/voluptate/posts/amet/statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/voluptate/posts/amet/statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/{company}/posts/{post}/statuses

URL Parameters

company  string  

post  string  

The post.

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/praesentium/posts/velit/statuses/et" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/praesentium/posts/velit/statuses/et"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/posts/{post_id}/statuses/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the status.

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/quo/posts/qui/statuses/mollitia" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/quo/posts/qui/statuses/mollitia"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/{company}/posts/{post_id}/statuses/{id}

PATCH api/{company}/posts/{post_id}/statuses/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the status.

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/repellendus/posts/dignissimos/statuses/id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/repellendus/posts/dignissimos/statuses/id"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/posts/{post_id}/statuses/{id}

URL Parameters

company  string  

post_id  string  

The ID of the post.

id  string  

The ID of the status.

Public Events

Public access to published events and projects

GET api/public/{companyUuid}/events

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/public/quasi/events" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/public/quasi/events"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 992
vary: Origin
 

{
    "message": "No query results for model [App\\Models\\Company].",
    "exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
    "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
    "line": 391,
    "trace": [
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
            "line": 367,
            "function": "prepareException",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/app/Exceptions/Handler.php",
            "line": 48,
            "function": "render",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/nunomaduro/collision/src/Adapters/Laravel/ExceptionHandler.php",
            "line": 54,
            "function": "render",
            "class": "App\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php",
            "line": 51,
            "function": "render",
            "class": "NunoMaduro\\Collision\\Adapters\\Laravel\\ExceptionHandler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 143,
            "function": "handleException",
            "class": "Illuminate\\Routing\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php",
            "line": 50,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 126,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 92,
            "function": "handleRequest",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 54,
            "function": "handleRequestUsingNamedLimiter",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 797,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 190,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Foundation\\Http\\Kernel::dispatchToRouter():187}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestIpMiddleware.php",
            "line": 45,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestIpMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestMiddleware.php",
            "line": 31,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/fruitcake/laravel-cors/src/HandleCors.php",
            "line": 52,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 39,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 165,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 134,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 176,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 41,
            "function": "{closure:Illuminate\\Container\\BoundMethod::call():35}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 661,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 183,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Command/Command.php",
            "line": 326,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 152,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 1098,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 324,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 175,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Application.php",
            "line": 102,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 155,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/artisan",
            "line": 35,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}
 

Request      

GET api/public/{companyUuid}/events

URL Parameters

companyUuid  string  

GET api/public/{companyUuid}/events/{slug}

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/public/et/events/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/public/et/events/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 991
vary: Origin
 

{
    "message": "No query results for model [App\\Models\\Company].",
    "exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
    "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
    "line": 391,
    "trace": [
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
            "line": 367,
            "function": "prepareException",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/app/Exceptions/Handler.php",
            "line": 48,
            "function": "render",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/nunomaduro/collision/src/Adapters/Laravel/ExceptionHandler.php",
            "line": 54,
            "function": "render",
            "class": "App\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php",
            "line": 51,
            "function": "render",
            "class": "NunoMaduro\\Collision\\Adapters\\Laravel\\ExceptionHandler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 143,
            "function": "handleException",
            "class": "Illuminate\\Routing\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php",
            "line": 50,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 126,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 92,
            "function": "handleRequest",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 54,
            "function": "handleRequestUsingNamedLimiter",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 797,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 190,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Foundation\\Http\\Kernel::dispatchToRouter():187}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestIpMiddleware.php",
            "line": 45,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestIpMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestMiddleware.php",
            "line": 31,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/fruitcake/laravel-cors/src/HandleCors.php",
            "line": 52,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 39,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 165,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 134,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 176,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 41,
            "function": "{closure:Illuminate\\Container\\BoundMethod::call():35}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 661,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 183,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Command/Command.php",
            "line": 326,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 152,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 1098,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 324,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 175,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Application.php",
            "line": 102,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 155,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/artisan",
            "line": 35,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}
 

Request      

GET api/public/{companyUuid}/events/{slug}

URL Parameters

companyUuid  string  

slug  integer  

The slug of the event.

Public Form

Endpoints publics pour la récupération des formulaires (app mobile citoyenne).

List active forms for a company identified by its UUID.

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/public/companies/550e8400-e29b-41d4-a716-446655440000/forms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/public/companies/550e8400-e29b-41d4-a716-446655440000/forms"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 997
vary: Origin
 

{
    "message": "No query results for model [App\\Models\\Company].",
    "exception": "Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException",
    "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
    "line": 391,
    "trace": [
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php",
            "line": 367,
            "function": "prepareException",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/app/Exceptions/Handler.php",
            "line": 48,
            "function": "render",
            "class": "Illuminate\\Foundation\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/nunomaduro/collision/src/Adapters/Laravel/ExceptionHandler.php",
            "line": 54,
            "function": "render",
            "class": "App\\Exceptions\\Handler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Pipeline.php",
            "line": 51,
            "function": "render",
            "class": "NunoMaduro\\Collision\\Adapters\\Laravel\\ExceptionHandler",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 143,
            "function": "handleException",
            "class": "Illuminate\\Routing\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php",
            "line": 50,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 126,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 92,
            "function": "handleRequest",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Middleware/ThrottleRequests.php",
            "line": 54,
            "function": "handleRequestUsingNamedLimiter",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 797,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 190,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 141,
            "function": "{closure:Illuminate\\Foundation\\Http\\Kernel::dispatchToRouter():187}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestIpMiddleware.php",
            "line": 45,
            "function": "{closure:Illuminate\\Pipeline\\Pipeline::prepareDestination():139}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestIpMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/sentry/sentry-laravel/src/Sentry/Laravel/Http/SetRequestMiddleware.php",
            "line": 31,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Sentry\\Laravel\\Http\\SetRequestMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/fruitcake/laravel-cors/src/HandleCors.php",
            "line": 52,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Fruitcake\\Cors\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 39,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 116,
            "function": "{closure:{closure:Illuminate\\Pipeline\\Pipeline::carry():155}:156}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 165,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 134,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 89,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 222,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 176,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 116,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 123,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 80,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 56,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 41,
            "function": "{closure:Illuminate\\Container\\BoundMethod::call():35}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 661,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 183,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Command/Command.php",
            "line": 326,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 152,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 1098,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 324,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/symfony/console/Application.php",
            "line": 175,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Console/Application.php",
            "line": 102,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 155,
            "function": "run",
            "class": "Illuminate\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/clients/client0/web1/web/crm/releases/124/artisan",
            "line": 35,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}
 

Request      

GET api/public/companies/{uuid}/forms

URL Parameters

uuid  string  

The UUID of the company.

Roles & Permissions

Manage role permissions per company

List all roles with their effective permissions for this company.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/est/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/est/roles"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/roles

URL Parameters

company  string  

List default permissions per role (global, no company overrides).

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/repellendus/roles/defaults" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/repellendus/roles/defaults"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/roles/defaults

URL Parameters

company  string  

Bulk update permissions for multiple roles in this company.

requires authentication

Body: { "roles": { "1": { "posts.delete": false }, "3": { "comments.create": true } } }

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/pariatur/roles/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"roles\": [
        [
            false
        ]
    ]
}"
const url = new URL(
    "https://api.demo.bouge.io/api/pariatur/roles/permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "roles": [
        [
            false
        ]
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/roles/permissions

URL Parameters

company  string  

Body Parameters

roles  boolean[][]  

Toggle permissions for a role in this company.

requires authentication

Body: { "permissions": { "posts.delete": false, "posts.export": true } }

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/porro/roles/1/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"permissions\": [
        false
    ]
}"
const url = new URL(
    "https://api.demo.bouge.io/api/porro/roles/1/permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "permissions": [
        false
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/roles/{role_id}/permissions

URL Parameters

company  string  

role_id  integer  

The ID of the role.

Body Parameters

permissions  boolean[]  

Statistics

Statistiques de performance et de volumétrie des signalements.

Public statistics

Statistiques publiques agrégées (sans authentification).

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/public/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date_from\": \"2026-06-04T21:33:29\",
    \"date_to\": \"2026-06-04T21:33:29\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/public/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "date_from": "2026-06-04T21:33:29",
    "date_to": "2026-06-04T21:33:29"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 987
vary: Origin
 

{
    "error": "UNAUTHORIZED",
    "message": "You can not access this ressource"
}
 

Request      

GET api/public/statistics

Body Parameters

date_from  string optional  

validation.date.

date_to  string optional  

validation.date.

form_id  string optional  

GET api/{company}/stats/performance

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/quo/stats/performance" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date_from\": \"2026-06-04T21:33:29\",
    \"date_to\": \"2026-06-04T21:33:29\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/quo/stats/performance"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "date_from": "2026-06-04T21:33:29",
    "date_to": "2026-06-04T21:33:29"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/stats/performance

URL Parameters

company  string  

Body Parameters

date_from  string optional  

validation.date.

date_to  string optional  

validation.date.

GET api/{company}/stats/volumetry

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/qui/stats/volumetry" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date_from\": \"2026-06-04T21:33:29\",
    \"date_to\": \"2026-06-04T21:33:29\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/qui/stats/volumetry"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "date_from": "2026-06-04T21:33:29",
    "date_to": "2026-06-04T21:33:29"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/stats/volumetry

URL Parameters

company  string  

Body Parameters

date_from  string optional  

validation.date.

date_to  string optional  

validation.date.

Statistics dashboard

List available metrics

requires authentication

Retourne le catalogue des métriques disponibles avec leurs labels localisés.

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/commodi/statistics/catalog" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/commodi/statistics/catalog"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "metrics": [
        {
            "id": "total_posts",
            "label": "Total signalements",
            "description": "Nombre total de signalements reçus sur la période.",
            "type": "count",
            "unit": "none",
            "display": "number"
        }
    ]
}
 

Request      

GET api/{company}/statistics/catalog

URL Parameters

company  string  

Compute metrics

requires authentication

Calcule les métriques demandées par leurs IDs (séparés par virgule). Les IDs inconnus sont ignorés silencieusement.

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/sed/statistics/metrics?ids=total_posts%2Cavg_resolution_time&from=2024-01-01&to=2024-12-31" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ids\": \"excepturi\",
    \"from\": \"2026-06-04T21:33:28\",
    \"to\": \"2106-06-22\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/sed/statistics/metrics"
);

const params = {
    "ids": "total_posts,avg_resolution_time",
    "from": "2024-01-01",
    "to": "2024-12-31",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ids": "excepturi",
    "from": "2026-06-04T21:33:28",
    "to": "2106-06-22"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "metrics": {
        "total_posts": 142,
        "avg_resolution_time": 3.5
    }
}
 

Example response (422, Trop de métriques):


{
    "message": "Cannot request more than 15 metrics at once."
}
 

Request      

GET api/{company}/statistics/metrics

URL Parameters

company  string  

Query Parameters

ids  string  

IDs des métriques séparés par virgule (max 15).

from  string optional  

Date de début de période (format Y-m-d).

to  string optional  

Date de fin de période (format Y-m-d).

Body Parameters

ids  string  

from  string optional  

validation.date.

to  string optional  

validation.date validation.after_or_equal.

Get dashboard metrics

requires authentication

Calcule les métriques configurées pour le tableau de bord de la company (ou les métriques par défaut si aucune config sauvegardée).

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/cupiditate/statistics/dashboard?from=2024-01-01&to=2024-12-31" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"from\": \"2026-06-04T21:33:28\",
    \"to\": \"2101-06-26\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/cupiditate/statistics/dashboard"
);

const params = {
    "from": "2024-01-01",
    "to": "2024-12-31",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "from": "2026-06-04T21:33:28",
    "to": "2101-06-26"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "ids": [
        "total_posts",
        "avg_resolution_time",
        "open_posts"
    ],
    "metrics": {
        "total_posts": 142,
        "avg_resolution_time": 3.5,
        "open_posts": 28
    }
}
 

Request      

GET api/{company}/statistics/dashboard

URL Parameters

company  string  

Query Parameters

from  string optional  

Date de début de période (format Y-m-d).

to  string optional  

Date de fin de période (format Y-m-d).

Body Parameters

from  string optional  

validation.date.

to  string optional  

validation.date validation.after_or_equal.

Get dashboard config

requires authentication

Retourne la sélection de métriques sauvegardée pour le tableau de bord (ou les valeurs par défaut).

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/corporis/statistics/dashboard/config" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/corporis/statistics/dashboard/config"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "ids": [
        "total_posts",
        "avg_resolution_time"
    ],
    "is_default": false
}
 

Request      

GET api/{company}/statistics/dashboard/config

URL Parameters

company  string  

Update dashboard config

requires authentication

Sauvegarde la sélection de métriques du tableau de bord. Chaque ID doit exister dans le catalogue — les IDs inconnus sont rejetés.

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/est/statistics/dashboard/config" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ids\": [
        \"total_posts\",
        \"open_posts\"
    ]
}"
const url = new URL(
    "https://api.demo.bouge.io/api/est/statistics/dashboard/config"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ids": [
        "total_posts",
        "open_posts"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "ids": [
        "total_posts",
        "open_posts"
    ]
}
 

Example response (422, ID inconnu):


{
    "message": "The selected ids.0 is invalid.",
    "errors": {
        "ids.0": [
            "The selected ids.0 is invalid."
        ]
    }
}
 

Request      

PUT api/{company}/statistics/dashboard/config

URL Parameters

company  string  

Body Parameters

ids  string[]  

Liste des IDs de métriques à afficher.

System

Endpoints système (health check, état des services).

GET api/health

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/health" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/health"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 1000
x-ratelimit-remaining: 999
vary: Origin
 

{
    "status": "ok",
    "timestamp": "2026-06-04T21:33:27+00:00",
    "services": {
        "database": "ok",
        "redis": "ok"
    }
}
 

Request      

GET api/health

Users

search users from given name or email

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/eos/citizen/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 11
}"
const url = new URL(
    "https://api.demo.bouge.io/api/eos/citizen/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 11
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/citizen/{id}

URL Parameters

company  string  

id  integer  

The ID of the citizen.

Body Parameters

id  integer optional  

search users from given name or email

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/aliquam/users/find" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/aliquam/users/find"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/users/find

URL Parameters

company  string  

Display a user profile with stats and history

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/recusandae/users/1/profile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/recusandae/users/1/profile"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/users/{user}/profile

URL Parameters

company  string  

user  integer  

The user.

search users from given name or email

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/rerum/users/1/locale" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"locale\": \"fr\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/rerum/users/1/locale"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "locale": "fr"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/users/{user}/locale

URL Parameters

company  string  

user  integer  

The user.

Body Parameters

locale  string  

Must be one of fr or en.

search users from given name or email

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/dolorum/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/dolorum/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/users

URL Parameters

company  string  

Create a new User on backoffice

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/quo/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Marie Dupont\",
    \"email\": \"marie.dupont@maville.fr\",
    \"locale\": \"fr\",
    \"job_title\": \"Responsable voirie\",
    \"password\": \"secret\",
    \"role\": \"agent\",
    \"phone\": \"uwviiklrjw\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/quo/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Marie Dupont",
    "email": "marie.dupont@maville.fr",
    "locale": "fr",
    "job_title": "Responsable voirie",
    "password": "secret",
    "role": "agent",
    "phone": "uwviiklrjw"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/users

URL Parameters

company  string  

Body Parameters

name  string  

Nom complet de l'utilisateur. validation.min.

email  string  

Adresse email (unique dans la plateforme). validation.email.

locale  string  

Langue de l'interface (fr, en…). Must be one of fr or en.

job_title  string  

Intitulé du poste.

password  string  

Mot de passe initial.

role  string  

Rôle dans le CRM : admin, manager, agent ou viewer. Must be one of admin, manager, agent, or viewer.

phone  string optional  

validation.max.

Display a specific user

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/optio/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/optio/users/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/users/{id}

URL Parameters

company  string  

id  integer  

The ID of the user.

Update a User based on its ID

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/vel/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Marie Dupont\",
    \"email\": \"marie.dupont@maville.fr\",
    \"locale\": \"fr\",
    \"job_title\": \"Responsable voirie\",
    \"role\": \"manager\",
    \"phone\": \"txukueannngunavsieak\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/vel/users/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Marie Dupont",
    "email": "marie.dupont@maville.fr",
    "locale": "fr",
    "job_title": "Responsable voirie",
    "role": "manager",
    "phone": "txukueannngunavsieak"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company}/users/{id}

PATCH api/{company}/users/{id}

URL Parameters

company  string  

id  integer  

The ID of the user.

Body Parameters

name  string  

Nom complet de l'utilisateur. validation.min.

email  string  

Adresse email. validation.email.

locale  string  

Langue de l'interface (fr, en…). Must be one of fr or en.

job_title  string  

Intitulé du poste.

role  string optional  

Rôle dans le CRM : admin, manager, agent ou viewer (optionnel). Must be one of admin, manager, agent, or viewer.

phone  string optional  

validation.max.

Delete an user based on its ID

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/amet/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/amet/users/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company}/users/{id}

URL Parameters

company  string  

id  integer  

The ID of the user.

Webhooks

Configuration des webhooks sortants par company.

search users from given name or email

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/itaque/webhooks" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/itaque/webhooks"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company}/webhooks

URL Parameters

company  string  

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "https://api.demo.bouge.io/api/blanditiis/webhooks" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 19941537.693494,
    \"name\": \"Notification Slack nouveaux signalements\",
    \"url\": \"https:\\/\\/hooks.slack.com\\/services\\/xxx\\/yyy\\/zzz\",
    \"signature_secret\": \"my_super_secret_key\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/blanditiis/webhooks"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 19941537.693494,
    "name": "Notification Slack nouveaux signalements",
    "url": "https:\/\/hooks.slack.com\/services\/xxx\/yyy\/zzz",
    "signature_secret": "my_super_secret_key"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/{company}/webhooks

URL Parameters

company  string  

Body Parameters

id  number optional  

name  string  

Nom descriptif du webhook. validation.max.

url  string  

URL de destination (HTTPS recommandé). Must be a valid URL.

signature_secret  string  

Secret partagé pour vérifier la signature HMAC des payloads. validation.max.

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://api.demo.bouge.io/api/1/webhooks/19" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/1/webhooks/19"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/{company_id}/webhooks/{id}

URL Parameters

company_id  integer  

The ID of the company.

id  integer  

The ID of the webhook.

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "https://api.demo.bouge.io/api/1/webhooks/7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 7817.95222701,
    \"name\": \"Notification Slack nouveaux signalements\",
    \"url\": \"https:\\/\\/hooks.slack.com\\/services\\/xxx\\/yyy\\/zzz\",
    \"signature_secret\": \"my_super_secret_key\"
}"
const url = new URL(
    "https://api.demo.bouge.io/api/1/webhooks/7"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 7817.95222701,
    "name": "Notification Slack nouveaux signalements",
    "url": "https:\/\/hooks.slack.com\/services\/xxx\/yyy\/zzz",
    "signature_secret": "my_super_secret_key"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/{company_id}/webhooks/{id}

PATCH api/{company_id}/webhooks/{id}

URL Parameters

company_id  integer  

The ID of the company.

id  integer  

The ID of the webhook.

Body Parameters

id  number optional  

name  string  

Nom descriptif du webhook. validation.max.

url  string  

URL de destination (HTTPS recommandé). Must be a valid URL.

signature_secret  string  

Secret partagé pour vérifier la signature HMAC des payloads. validation.max.

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://api.demo.bouge.io/api/1/webhooks/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.demo.bouge.io/api/1/webhooks/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/{company_id}/webhooks/{id}

URL Parameters

company_id  integer  

The ID of the company.

id  integer  

The ID of the webhook.