Saltar al contenido principal
GET
List organization asset groups

Descripción general

Lista todos los grupos de assets (Asset: activo digital, como una URL, dirección, perfil, app, etc.) que pertenecen a tu organización. Los grupos de assets te ayudan a organizar tus assets por categoría, proyecto o propósito. Cada grupo incluye un conteo de los assets asignados para facilitar la gestión del inventario.

Inicio rápido

Autenticación

Incluye tu clave de API en el encabezado X-API-KEY:

Solicitud de ejemplo

Respuesta

Respuesta exitosa

Campos de la respuesta

Respuestas de error

401 Unauthorized

Se devuelve cuando falta la clave de API, no es válida o no tiene acceso a la organización:

Casos de uso

Mostrar estadísticas de los grupos

Buscar un grupo por nombre

Identificar grupos vacíos

Crear un selector de grupos para la interfaz

Exportar un resumen de los grupos

Monitorear el crecimiento de los grupos

Buenas prácticas

Caché

  • Guarda en caché las listas de grupos cuando construyas menús desplegables en la interfaz para reducir las llamadas a la API
  • Invalida la caché cuando se creen, actualicen o eliminen grupos
  • Considera un TTL de caché de 5 a 10 minutos para los casos de uso típicos

Rendimiento

  • Este endpoint devuelve todos los grupos en una sola solicitud (no se necesita paginación)
  • Los grupos suelen ser pocos (< 100 en la mayoría de las organizaciones)
  • Usa este endpoint para construir tablas de búsqueda que relacionen el ID de cada grupo con su nombre

Integración

Notas

  • La organización se determina automáticamente a partir de tu clave de API
  • Todos los grupos que pertenecen a tu organización se devuelven en una sola respuesta
  • assetCount refleja la cantidad actual de assets asignados a cada grupo
  • Los grupos con cero assets igualmente se incluyen en la respuesta
  • Los ID de grupo son únicos dentro de tu organización
  • Este endpoint no admite paginación porque la cantidad de grupos suele ser pequeña

Autorizaciones

X-API-KEY
string
header
requerido

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Respuesta

Successful response

Successful operation

groups
object[]
requerido

List of asset groups