v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB
Domains

Retrieve a route by address

Returns the route bound to <address>@<domain>. Use * as the address to retrieve the wildcard route for the domain.

get/v1/domains/{domain}/routes/{address}

Path parameters

domainstring required
addressstring required

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

_idstring required
_domainIdstring required
addressstring required
agentIdstring

Internal id of the destination agent. Only present for agent routes.

type'agent' | 'webhook' required
_environmentIdstring required
_organizationIdstring required
createdAtstring required
updatedAtstring required
dataobject

String key-value metadata (max 10 keys, 500 characters total when set via API).