Proyectos

Obtener todos

GET https://vtx.best/api/projects/
curl --request GET \
--url 'https://vtx.best/api/projects/' \
--header 'Authorization: Bearer {api_key}' \
Parámetros Detalles Descripción
search Opcional Cadena de texto El texto de búsqueda.
search_by Opcional Cadena de texto El campo por el que buscas. Valores permitidos: name.
datetime_field Opcional Cadena de texto Valores permitidos: datetime, last_datetime
datetime_start Opcional Cadena de texto Filtra los resultados a partir de esta fecha y hora. Formato Y-m-d H:i:s.
datetime_end Opcional Cadena de texto Filtra los resultados hasta esta fecha y hora. Formato Y-m-d H:i:s.
order_by Opcional Cadena de texto El campo por el que se ordenan los resultados. Valores permitidos: project_id, datetime, last_datetime, name.
order_type Opcional Cadena de texto El orden de los resultados. Valores permitidos: ASC para orden ascendente y DESC para orden descendente.
page Opcional Número entero El número de página del que quieres obtener resultados. El valor predeterminado es 1.
results_per_page Opcional Número entero La cantidad de resultados por página. Valores permitidos: 10, 25, 50, 100, 250, 500, 1000. El valor predeterminado es 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "name": "Example",
            "color": "#000000",
            "email_reports": [],
            "last_datetime": null,
            "datetime": "2026-10-26 06:28:28"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://vtx.best/api/projects?page=1",
        "last": "https://vtx.best/api/projects?page=1",
        "next": null,
        "prev": null,
        "self": "https://vtx.best/api/projects?page=1"
    }
}

Obtener uno

GET https://vtx.best/api/projects/{project_id}
curl --request GET \
--url 'https://vtx.best/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example",
        "color": "#000000",
        "email_reports": [],
        "last_datetime": null,
        "datetime": "2026-10-26 06:28:28"
    }
}

Crear

POST https://vtx.best/api/projects
Parámetros Detalles Descripción
name Obligatorio Cadena de texto -
color Opcional Cadena de texto -
email_reports Opcional Arreglo ID de los canales de notificación
curl --request POST \
--url 'https://vtx.best/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Production' \
--form 'color=#ffffff' \
--form 'email_reports[]=1' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example",
        "color": "#000000",
        "email_reports": [],
        "last_datetime": null,
        "datetime": "2026-10-26 06:28:28"
    }
}

Actualizar

POST https://vtx.best/api/projects/{project_id}
Parámetros Detalles Descripción
name Opcional Cadena de texto -
color Opcional Cadena de texto -
email_reports Opcional Arreglo ID de los canales de notificación
curl --request POST \
--url 'https://vtx.best/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Production' \
--form 'color=#000000' \
--form 'email_reports[]=1' \
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example",
        "color": "#000000",
        "email_reports": [],
        "last_datetime": null,
        "datetime": "2026-10-26 06:28:28"
    }
}

Eliminar

DELETE https://vtx.best/api/projects/{project_id}
curl --request DELETE \
--url 'https://vtx.best/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \