Get an inbound route

Retrieve one inbound route by id with its expression, ordered actions, priority and enabled flag; secrets are never returned.

Returns a single route: expression, the ordered actions (a forward action shows its url and has_secret, never the secret), priority, enabled and created_at.

GET /v3/routes/{id}

Requires a full_access or read_only key — a send_only key is denied. Routes of other workspaces answer 404.

Responses

Status	Description
`200`	OK. The route.
`401`	Missing or invalid API key.
`403`	`insufficient_scope` — a `send_only` key cannot read routes.
`404`	No such route on your workspace.

Code examples

cURL

curl https://api.wemail.io/v3/routes/0b7e4c2d-9a1f-4e6b-8c3d-5f2a1b9e7d40 \
  -H "Authorization: Bearer afn_live_…"

Node.js

const res = await fetch("https://api.wemail.io/v3/routes/0b7e4c2d-9a1f-4e6b-8c3d-5f2a1b9e7d40", {
  headers: { Authorization: `Bearer ${process.env.WEMAIL_API_KEY}` },
});
const route = await res.json();

Python

import os, requests

r = requests.get(
    "https://api.wemail.io/v3/routes/0b7e4c2d-9a1f-4e6b-8c3d-5f2a1b9e7d40",
    headers={"Authorization": f"Bearer {os.environ['WEMAIL_API_KEY']}"},
)
route = r.json()

client, _ := wemail.NewClient(os.Getenv("WEMAIL_API_KEY"))
ctx := context.WithValue(context.Background(), wemail.ContextAccessToken, os.Getenv("WEMAIL_API_KEY"))
route, _, err := client.API.RoutesAPI.GetInboundRoute(ctx, "0b7e4c2d-9a1f-4e6b-8c3d-5f2a1b9e7d40").Execute()

ResponseExample response

{
  "id": "0b7e4c2d-9a1f-4e6b-8c3d-5f2a1b9e7d40",
  "account_id": "acc_01HBYD3M…",
  "expression": "match_recipient(\".*@leads\\\\.example\\\\.com\")",
  "actions": [
    { "type": "store" },
    { "type": "forward", "url": "https://app.example.com/inbound", "has_secret": true }
  ],
  "priority": 10,
  "enabled": true,
  "created_at": "2026-11-03T07:59:30.000Z"
}