Obtener una lista

GET /api/v1/lists/{listId} Una lista.
bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/lists/$LIST_ID"
El detalle no lleva contactCount: el recuento solo se calcula al listar. Una lista que no existe, una lista que eliminaste y una lista que pertenece a otra organización responden todas 404: la API nunca te dice que un id existe cuando no es tuyo, y una lista eliminada ya no es direccionable.

Autorización

Rol en la organizaciónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERPermitido
Una clave lleva el rol que su creador tiene en esta organización, nunca un rol sobre AgentsMail en sí. Consulta Claves de API.

Parámetros de ruta

ParámetroTipoDescripción
listIdstringObligatorio. La lista que se va a leer

Ejemplo

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/lists/$LIST_ID"

Respuesta

  • 200 OK: la llamada se realizó correctamente.
  • 401 Unauthorized: clave ausente o no válida, o su propietario salió de la organización.
  • 404 Not Found: no existe ese recurso, o lo eliminaste, o pertenece a otra organización. La API nunca confirma que un id existe a un llamante que no tiene derecho sobre él.
  • 429 Too Many Requests: más de 120 solicitudes en un minuto para esta clave.

Campos de la respuesta

CampoTipoDescripción
successbooleanIndica si la operación se realizó correctamente
data.idstringIdentificador de la lista
data.namestringSu nombre
data.contactCountnumberContactos que contiene
data.createdAt / updatedAtstringFechas ISO

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "name": "Newsletter",
    "contactCount": 128,
    "createdAt` / `updatedAt": "value"
  }
}

Notas

  • Eliminar una lista en la interfaz hace que responda 404 aquí, de inmediato y para siempre. No se borra nada en los informes: las campañas enviadas a ella conservan sus estadísticas y sus destinatarios.

Relacionado