Skip to main content
Cada endpoint de esta referencia vive bajo https://api.legal.usecroma.com y se autentica con una clave de API de tipo bearer. Elige un endpoint en la barra lateral para ver sus parámetros, el esquema de respuesta, un ejemplo y un playground de “pruébalo”.

Endpoints

Convenciones

  • Auth: Authorization: Bearer <clave> en cada endpoint. Consulta Autenticación.
  • Los endpoints de lectura son GET con los filtros como parámetros de consulta; solo las exportaciones son un POST con cuerpo JSON.
  • Éxito: las respuestas envuelven la carga bajo data: { "data": … }. Las listas agregan next_cursor y has_more (o total).
  • Errores: { "error": { "type", "code", "message" } } con un estado distinto de 2xx. Consulta Errores.
  • Sin coincidencia: una lista vacía es un 200, no un 404. Solo los endpoints de un proceso individual devuelven 404, cuando el id o radicado no está en tu organización.
  • Nombres de campo en snake_case; fechas en ISO 8601 en UTC; ids en UUID, y los procesos aceptan también su radicado.
  • Límites de tasa: se reportan en los encabezados de respuesta X-RateLimit-*. Consulta Límites de tasa.
  • Alcance: cada respuesta está limitada a la organización dueña de la clave. No hay un parámetro para elegir otra organización.
Los nombres de parámetros y las descripciones de campos de cada endpoint se muestran en inglés, el idioma del contrato de la API.

Paginación y filtros

Cursores, tamaños de página, semántica de fechas y sincronización incremental.

Exportaciones

Espera en línea, haz polling u obtén un callback para el conjunto completo.