MENU navbar-image

Introduction

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

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

This API is not authenticated.

Endpoints

Muestra una lista paginada de compañías.

Corresponde al endpoint GET /api/companies

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/companies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/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: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 1,
            "name": "Compañía Test",
            "logoUrl": null,
            "description": "Esta es una compañía de prueba creada desde Postman",
            "phone": "3001234567",
            "catalogUrl": null,
            "schedule": null,
            "address": null,
            "city": "Bogotá",
            "location": null,
            "gameRoomUrl": null
        }
    ],
    "links": {
        "first": "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/companies?page=1",
        "last": "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/companies?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/companies?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/companies",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Request      

GET api/v1/companies

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Muestra los detalles de una compañía específica.

Corresponde al endpoint GET /api/companies/{id}

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/companies/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/companies/1"
);

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: 60
x-ratelimit-remaining: 58
access-control-allow-origin: *
 

{
    "data": {
        "id": 1,
        "name": "Compañía Test",
        "logoUrl": null,
        "description": "Esta es una compañía de prueba creada desde Postman",
        "phone": "3001234567",
        "catalogUrl": null,
        "schedule": null,
        "address": null,
        "city": "Bogotá",
        "location": null,
        "gameRoomUrl": null,
        "branches": []
    }
}

Request      

GET api/v1/companies/{company_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_id   integer   

The ID of the company. Example: 1

Muestra la lista maestra de todos los minijuegos disponibles.

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/minigames" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/minigames"
);

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: 60
x-ratelimit-remaining: 57
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 1,
            "name": "Pesca",
            "description": "Un minijuego de pesca donde debes evitar las anguilas eléctricas.",
            "gamePath": "pesca",
            "costInCoins": 10,
            "costInTickets": 10
        }
    ]
}

Request      

GET api/v1/minigames

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Muestra una lista pública de todos los eventos activos.

Corresponde al endpoint: GET /api/events

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events"
);

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: 60
x-ratelimit-remaining: 56
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 1,
            "description": "Evento de prueba desde Postman",
            "city": "Bogotá",
            "isActive": true,
            "duration": "3h",
            "createdAt": "2025-09-16T19:15:22+00:00",
            "company": {
                "id": 1,
                "name": "Compañía Test",
                "logoUrl": null,
                "description": "Esta es una compañía de prueba creada desde Postman",
                "phone": "3001234567",
                "catalogUrl": null,
                "schedule": null,
                "address": null,
                "city": "Bogotá",
                "location": null,
                "gameRoomUrl": null
            }
        }
    ],
    "links": {
        "first": "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events?page=1",
        "last": "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Request      

GET api/v1/events

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Muestra los detalles completos de un evento específico.

Corresponde al endpoint: GET /api/events/{event}

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events/1"
);

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: 60
x-ratelimit-remaining: 55
access-control-allow-origin: *
 

{
    "data": {
        "id": 1,
        "description": "Evento de prueba desde Postman",
        "city": "Bogotá",
        "isActive": true,
        "duration": "3h",
        "createdAt": "2025-09-16T19:15:22+00:00",
        "company": {
            "id": 1,
            "name": "Compañía Test",
            "logoUrl": null,
            "description": "Esta es una compañía de prueba creada desde Postman",
            "phone": "3001234567",
            "catalogUrl": null,
            "schedule": null,
            "address": null,
            "city": "Bogotá",
            "location": null,
            "gameRoomUrl": null
        },
        "minigames": [
            {
                "id": 1,
                "name": "Pesca",
                "description": "Un minijuego de pesca donde debes evitar las anguilas eléctricas.",
                "gamePath": "pesca",
                "costInCoins": 10,
                "costInTickets": 10
            }
        ]
    }
}

Request      

GET api/v1/events/{event_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event_id   integer   

The ID of the event. Example: 1

Maneja la solicitud de inicio de sesión del usuario.

Corresponde al endpoint POST /api/login

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"password\": \"consequatur\",
    \"device_name\": \"consequatur\"
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/login"
);

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

let body = {
    "email": "qkunze@example.com",
    "password": "consequatur",
    "device_name": "consequatur"
};

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

Request      

POST api/v1/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Example: qkunze@example.com

password   string   

Example: consequatur

device_name   string   

Example: consequatur

Registra un nuevo usuario y devuelve un token de Sanctum.

Corresponde al endpoint: POST /api/register

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"vmqeopfuudtdsufvyvddq\",
    \"last_name\": \"amniihfqcoynlazghdtqt\",
    \"username\": \"qxbajwbpilpmufinllwlo\",
    \"email\": \"schmitt.beulah@example.org\",
    \"password\": \"consequatur\",
    \"phone\": \"mqeopfuudtdsufvyv\"
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/register"
);

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

let body = {
    "first_name": "vmqeopfuudtdsufvyvddq",
    "last_name": "amniihfqcoynlazghdtqt",
    "username": "qxbajwbpilpmufinllwlo",
    "email": "schmitt.beulah@example.org",
    "password": "consequatur",
    "phone": "mqeopfuudtdsufvyv"
};

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

Request      

POST api/v1/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string   

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

last_name   string   

Must not be greater than 100 characters. Example: amniihfqcoynlazghdtqt

username   string   

Must not be greater than 100 characters. Example: qxbajwbpilpmufinllwlo

email   string   

Must be a valid email address. Must not be greater than 100 characters. Example: schmitt.beulah@example.org

password   string   

Example: consequatur

phone   string   

Must not be greater than 20 characters. Example: mqeopfuudtdsufvyv

Maneja la solicitud de cierre de sesión del usuario.

Corresponde al endpoint POST /api/logout

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/logout"
);

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

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

Request      

POST api/v1/logout

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/user

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/user"
);

const headers = {
    "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
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/user

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Actualiza la información del perfil del usuario autenticado.

Corresponde al endpoint: POST /api/user/profile

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/user/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"vmqeopfuudtdsufvyvddq\",
    \"last_name\": \"amniihfqcoynlazghdtqt\",
    \"username\": \"qxbajwbpilpmufinllwlo\",
    \"email\": \"schmitt.beulah@example.org\",
    \"birthdate\": \"2025-09-27T03:01:54\",
    \"gender\": \"smsjuryvojcybzvrb\",
    \"phone\": \"yickznkygloigmkwx\",
    \"current_city\": \"phlvazjrcnfbaqywuxhgj\"
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/user/profile"
);

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

let body = {
    "first_name": "vmqeopfuudtdsufvyvddq",
    "last_name": "amniihfqcoynlazghdtqt",
    "username": "qxbajwbpilpmufinllwlo",
    "email": "schmitt.beulah@example.org",
    "birthdate": "2025-09-27T03:01:54",
    "gender": "smsjuryvojcybzvrb",
    "phone": "yickznkygloigmkwx",
    "current_city": "phlvazjrcnfbaqywuxhgj"
};

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

Request      

POST api/v1/user/profile

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string   

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

last_name   string   

Must not be greater than 100 characters. Example: amniihfqcoynlazghdtqt

username   string   

Must not be greater than 100 characters. Example: qxbajwbpilpmufinllwlo

email   string   

Must be a valid email address. Must not be greater than 100 characters. Example: schmitt.beulah@example.org

birthdate   string  optional  

Must be a valid date. Example: 2025-09-27T03:01:54

gender   string  optional  

Must not be greater than 20 characters. Example: smsjuryvojcybzvrb

phone   string  optional  

Must not be greater than 20 characters. Example: yickznkygloigmkwx

current_city   string  optional  

Must not be greater than 100 characters. Example: phlvazjrcnfbaqywuxhgj

Devuelve los saldos actuales del usuario autenticado.

Corresponde al endpoint GET /api/user/balances

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/user/balances" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/user/balances"
);

const headers = {
    "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
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/user/balances

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Devuelve un historial paginado de las transacciones del usuario.

Corresponde al endpoint GET /api/user/transactions

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/user/transactions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/user/transactions"
);

const headers = {
    "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
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/user/transactions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Inicia una partida para el usuario autenticado.

Corresponde al endpoint: POST /api/minigames/{minigame}/play

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/minigames/1/play" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"payment_method\": \"consequatur\",
    \"event_id\": \"consequatur\"
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/minigames/1/play"
);

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

let body = {
    "payment_method": "consequatur",
    "event_id": "consequatur"
};

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

Request      

POST api/v1/minigames/{minigame_id}/play

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

minigame_id   integer   

The ID of the minigame. Example: 1

Body Parameters

payment_method   string   

Example: consequatur

event_id   string   

The id of an existing record in the events table. Example: consequatur

Guarda la puntuación del usuario al finalizar una partida.

Corresponde al endpoint: POST /api/scores

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/scores" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"minigame_id\": \"consequatur\",
    \"event_id\": \"consequatur\",
    \"score\": 45
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/scores"
);

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

let body = {
    "minigame_id": "consequatur",
    "event_id": "consequatur",
    "score": 45
};

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

Request      

POST api/v1/scores

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

minigame_id   string   

The id of an existing record in the minigames table. Example: consequatur

event_id   string   

The id of an existing record in the events table. Example: consequatur

score   integer   

Must be at least 0. Example: 45

Crea una nueva compañía y asigna al usuario actual como su administrador.

Corresponde al endpoint: POST /api/companies

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/companies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"city\": \"dtdsufvyvddqamniihfqc\",
    \"phone\": \"oynlazghdtqtqxbaj\"
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/companies"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "city": "dtdsufvyvddqamniihfqc",
    "phone": "oynlazghdtqtqxbaj"
};

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

Request      

POST api/v1/companies

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

city   string   

Must not be greater than 100 characters. Example: dtdsufvyvddqamniihfqc

phone   string  optional  

Must not be greater than 20 characters. Example: oynlazghdtqtqxbaj

Crea un nuevo evento para la compañía del administrador.

Corresponde al endpoint: POST /api/events

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"city\": \"dtdsufvyvddqamniihfqc\",
    \"is_active\": false,
    \"duration\": \"consequatur\",
    \"minigame_ids\": [
        17
    ]
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events"
);

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

let body = {
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "city": "dtdsufvyvddqamniihfqc",
    "is_active": false,
    "duration": "consequatur",
    "minigame_ids": [
        17
    ]
};

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

Request      

POST api/v1/events

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

description   string   

Example: Dolores dolorum amet iste laborum eius est dolor.

city   string   

Must not be greater than 100 characters. Example: dtdsufvyvddqamniihfqc

is_active   boolean  optional  

Example: false

duration   string  optional  

Example: consequatur

minigame_ids   integer[]  optional  

Esperamos un array de IDs de minijuegos. The id of an existing record in the minigames table.

Actualiza un evento existente.

Corresponde al endpoint: PUT /api/events/{event}

Example request:
curl --request PUT \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"city\": \"dtdsufvyvddqamniihfqc\",
    \"is_active\": false,
    \"duration\": \"consequatur\",
    \"minigame_ids\": [
        17
    ]
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/events/1"
);

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

let body = {
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "city": "dtdsufvyvddqamniihfqc",
    "is_active": false,
    "duration": "consequatur",
    "minigame_ids": [
        17
    ]
};

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

Request      

PUT api/v1/events/{event_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event_id   integer   

The ID of the event. Example: 1

Body Parameters

description   string   

Example: Dolores dolorum amet iste laborum eius est dolor.

city   string   

Must not be greater than 100 characters. Example: dtdsufvyvddqamniihfqc

is_active   boolean  optional  

Example: false

duration   string  optional  

Example: consequatur

minigame_ids   integer[]  optional  

The id of an existing record in the minigames table.

Muestra la lista de eventos (activos e inactivos) de la compañía del usuario administrador autenticado.

Corresponde al endpoint: GET /api/my-company/events

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/my-company/events" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/my-company/events"
);

const headers = {
    "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
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/my-company/events

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Muestra una lista de todos los usuarios.

Este método corresponde al endpoint GET /api/users.

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/admin/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/admin/users"
);

const headers = {
    "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
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/admin/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Almacena un nuevo usuario en la base de datos.

Este método corresponde al endpoint POST /api/users.

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/admin/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"vmqeopfuudtdsufvyvddq\",
    \"last_name\": \"amniihfqcoynlazghdtqt\",
    \"username\": \"qxbajwbpilpmufinllwlo\",
    \"email\": \"schmitt.beulah@example.org\",
    \"password\": \"consequatur\",
    \"special\": \"consequatur\",
    \"role\": \"consequatur\",
    \"birthdate\": \"2025-09-27T03:01:54\",
    \"gender\": \"mqeopfuudtdsufvyv\",
    \"phone\": \"ddqamniihfqcoynla\"
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/admin/users"
);

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

let body = {
    "first_name": "vmqeopfuudtdsufvyvddq",
    "last_name": "amniihfqcoynlazghdtqt",
    "username": "qxbajwbpilpmufinllwlo",
    "email": "schmitt.beulah@example.org",
    "password": "consequatur",
    "special": "consequatur",
    "role": "consequatur",
    "birthdate": "2025-09-27T03:01:54",
    "gender": "mqeopfuudtdsufvyv",
    "phone": "ddqamniihfqcoynla"
};

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

Request      

POST api/v1/admin/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string   

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

last_name   string   

Must not be greater than 100 characters. Example: amniihfqcoynlazghdtqt

username   string   

Must not be greater than 100 characters. Example: qxbajwbpilpmufinllwlo

email   string   

Must be a valid email address. Must not be greater than 100 characters. Example: schmitt.beulah@example.org

password   string   

Example: consequatur

special   string  optional  

Example: consequatur

role   string   

Example: consequatur

company_id   string  optional  

The id of an existing record in the companies table.

birthdate   string  optional  

Must be a valid date. Example: 2025-09-27T03:01:54

gender   string  optional  

Must not be greater than 20 characters. Example: mqeopfuudtdsufvyv

phone   string  optional  

Must not be greater than 20 characters. Example: ddqamniihfqcoynla

Crea un nuevo minijuego en la lista maestra.

Corresponde al endpoint: POST /api/admin/minigames

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/admin/minigames" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"game_path\": \"consequatur\",
    \"cost_in_coins\": 45,
    \"cost_in_tickets\": 56
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/admin/minigames"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "game_path": "consequatur",
    "cost_in_coins": 45,
    "cost_in_tickets": 56
};

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

Request      

POST api/v1/admin/minigames

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

game_path   string   

Example: consequatur

cost_in_coins   integer  optional  

Must be at least 0. Example: 45

cost_in_tickets   integer  optional  

Must be at least 0. Example: 56

Handle incoming data from an external service.

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/receive-data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order_id\": \"consequatur\",
    \"customer\": {
        \"name\": \"consequatur\",
        \"email\": \"carolyne.luettgen@example.org\"
    },
    \"products\": [
        {
            \"id\": 17,
            \"quantity\": 45
        }
    ]
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/v1/receive-data"
);

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

let body = {
    "order_id": "consequatur",
    "customer": {
        "name": "consequatur",
        "email": "carolyne.luettgen@example.org"
    },
    "products": [
        {
            "id": 17,
            "quantity": 45
        }
    ]
};

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

Request      

POST api/v1/receive-data

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

order_id   string   

Example: consequatur

customer   object  optional  
name   string   

Example: consequatur

email   string   

Must be a valid email address. Example: carolyne.luettgen@example.org

products   object[]   
id   integer   

Example: 17

quantity   integer   

Must be at least 1. Example: 45

POST api/login

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/login"
);

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

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

Request      

POST api/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/register

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"vmqeopfuudtdsufvyvddq\",
    \"last_name\": \"amniihfqcoynlazghdtqt\",
    \"username\": \"qxbajwbpilpmufinllwlo\",
    \"email\": \"schmitt.beulah@example.org\",
    \"password\": \"LcDi`wmUB)z&~na%\",
    \"phone\": \"yickznkygloigmkwx\"
}"

const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/register"
);

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

let body = {
    "first_name": "vmqeopfuudtdsufvyvddq",
    "last_name": "amniihfqcoynlazghdtqt",
    "username": "qxbajwbpilpmufinllwlo",
    "email": "schmitt.beulah@example.org",
    "password": "LcDi`wmUB)z&~na%",
    "phone": "yickznkygloigmkwx"
};

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

Request      

POST api/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string   

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

last_name   string   

Must not be greater than 100 characters. Example: amniihfqcoynlazghdtqt

username   string   

Must not be greater than 100 characters. Example: qxbajwbpilpmufinllwlo

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: schmitt.beulah@example.org

password   string   

Must be at least 8 characters. Example: LcDiwmUB)z&~na%`

phone   string   

Must not be greater than 20 characters. Example: yickznkygloigmkwx

POST api/logout

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/logout"
);

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

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

Request      

POST api/logout

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/refresh

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/refresh"
);

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

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

Request      

POST api/refresh

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/token

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/token"
);

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

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

Request      

POST api/token

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/{datatype}

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/consequatur"
);

const headers = {
    "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
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/{datatype}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

datatype   string   

Example: consequatur

GET api/{datatype}/{id}

Example request:
curl --request GET \
    --get "https://hotpink-hedgehog-420087.hostingersite.com/api/consequatur/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/consequatur/consequatur"
);

const headers = {
    "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
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/{datatype}/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

datatype   string   

Example: consequatur

id   string   

The ID of the {datatype}. Example: consequatur

PUT api/{datatype}/{id}

Example request:
curl --request PUT \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/consequatur/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/consequatur/consequatur"
);

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

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

Request      

PUT api/{datatype}/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

datatype   string   

Example: consequatur

id   string   

The ID of the {datatype}. Example: consequatur

POST api/{datatype}

Example request:
curl --request POST \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/consequatur"
);

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

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

Request      

POST api/{datatype}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

datatype   string   

Example: consequatur

DELETE api/{datatype}/{id}

Example request:
curl --request DELETE \
    "https://hotpink-hedgehog-420087.hostingersite.com/api/consequatur/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://hotpink-hedgehog-420087.hostingersite.com/api/consequatur/consequatur"
);

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

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

Request      

DELETE api/{datatype}/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

datatype   string   

Example: consequatur

id   string   

The ID of the {datatype}. Example: consequatur