Schemas

Devuelve todos los schemas de la cuenta asociada al API key

Endpoint de solo lectura, sin body ni parámetros. Llama GET https://claix.dev/api/schemas. Dado un API key válido, devuelve la lista completa de schemas creados por el usuario dueño de esa key, con toda su información (id, nombre, tipo y definición), ordenados del más reciente al más antiguo. Esta llamada es gratuita: no se factura ni consume el cupo de extracciones.

get/schemas

Request

  • Base URL: https://claix.dev/api
  • URL: https://claix.dev/api/schemas
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Response

Lista de schemas obtenida correctamente

successboolean
total_schemasinteger

Número total de schemas devueltos.

Example response

{
  "success": true,
  "total_schemas": 5,
  "schemas": [
    {
      "id": "b980cfe7-61ef-4a5a-9724-881c8a5541e2",
      "name": "Facturas Trimestrales",
      "type": "pdf-json",
      "schema_definition": {
        "nif_cliente": {
          "type": "string",
          "description": "NIF o CIF del cliente facturado."
        }
      },
      "agent_definition": {
        "clausula_penalizacion": {
          "type": "boolean",
          "description": "Indica si el contrato incluye cláusula de penalización."
        }
      },
      "created_at": "2026-08-06T09:51:41.372964+00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.