Listar conexiones

GET /api/v1/sequences/{sequenceId}/versions/{versionId}/edges Todas las conexiones de la versión con su id, fromNodeId, toNodeId y branch. Léelas antes de desconectar: el id es la única forma de referirte a una conexión que nunca creaste a mano.

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 en AgentsMail en sí. Consulta Claves de API.

Parámetros de ruta

ParámetroTipoDescripción
versionIdstringObligatorio. La versión cuyas conexiones lees

Ejemplo

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/sequences/$SEQUENCE_ID/versions/$VERSION_ID/edges"

Respuesta

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

Campos de la respuesta

data es un array de conexiones.
CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
data[].idstringIdentificador de la conexión
data[].fromNodeIdstringPaso del que sale
data[].toNodeIdstringPaso al que llega
paginationobject{total, page, limit, totalPages}

Ejemplo de respuesta

json
{
  "success": true,
  "data": [
    {
      "id": "4d19c0a2",
      "fromNodeId": "d77b0913",
      "toNodeId": "e08c1a24"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Relacionado