Obtener un tema

GET /api/v1/topics/{topicId} Un tema, más lo que cuesta: el número de rechazos registrados sobre él y las campañas y secuencias que lo llevan. Eso es lo que te dice de antemano por qué se rechazará una eliminación.

Autorización

Rol en la organizaciónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERRechazado — 403
Este es más estricto que el listado: saber lo que contiene un tema es el mismo derecho que eliminarlo. Un member puede seguir leyendo los nombres y los id con Listar los temas. 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
topicIdstringObligatorio. El tema que se va a leer

Ejemplo

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

Respuesta

  • 200 OK: el tema y su uso.
  • 401 Unauthorized: clave ausente o no válida, o su propietario salió de la organización.
  • 403 Forbidden: el propietario de la clave es member de la organización, no admin.
  • 404 Not Found: no existe ese tema, 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 único del tema
data.namestringNombre del tema, único en la organización
data.createdAtstringFecha de creación ISO
data.updatedAtstringFecha ISO del último cambio
data.optOutCountnumberContactos que rechazaron este tema: se pierden si lo eliminas
data.campaignsarrayCampañas que lo llevan, {id, name, status}
data.sequencesarraySecuencias que lo llevan, {id, name, status}

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "7c2e4b19",
    "name": "freelancing",
    "createdAt": "2026-03-04T08:11:00.000Z",
    "updatedAt": "2026-08-01T10:42:19.000Z",
    "optOutCount": 42,
    "campaigns": [
      {"id": "4d19c0a2", "name": "Freelance news", "status": "sent"}
    ],
    "sequences": []
  }
}

Notas

  • Los recuentos se leen en directo. Una campaña creada hace un segundo ya aparece aquí; por eso una eliminación los vuelve a calcular en lugar de fiarse de lo que leíste la última vez.
  • campaigns y sequences vacíos significan que el tema se puede eliminar. optOutCount dice lo que esa eliminación tiraría.

Relacionado