List wires

GET /api/v1/sequences/{sequenceId}/versions/{versionId}/edges Every wire of the version with its id, fromNodeId, toNodeId and branch. Read it before unwiring: the id is the only handle on a wire you never created by hand.

Authorization

Role in the organizationThis endpoint
OWNERAllowed
ADMINAllowed
MEMBERAllowed
A key carries the role its creator holds in this organization — never a role on AgentsMail itself. See API keys.

Path parameters

ParameterTypeDescription
versionIdstringRequired. The version whose wires you read

Example

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

Response

  • 200 OK — the call succeeded.
  • 401 Unauthorized — missing or invalid key, or its owner left the organization.
  • 404 Not Found — no such resource, or it belongs to another organization. The API never confirms that an id exists to a caller who has no right to it.
  • 429 Too Many Requests — over 120 requests in a minute for this key.

Response fields

data is an array of wires.
FieldTypeDescription
successbooleanIndicates if the operation was successful
data[].idstringIdentifier of the wire
data[].fromNodeIdstringStep it leaves
data[].toNodeIdstringStep it reaches
paginationobject{total, page, limit, totalPages}

Example response

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