Routes

Get a Route by ID

<Callout intent="warning"> The endpoints exposed here are currently in **Beta**! As we continue to build our initial offering, these endpoints may implement breaking changes. Be sure to check back for our change log regularly as a precaution. </Callout>

Retrieve a single route by its id, including the full reusable instructions block. Route ids are deterministic — the same canonical inputs always derive the same id — so a 404 means no route with those parameters has been created for your organization.

get/v0/routes/{routeId}

Path parameters

routeIdstring uuid required

Headers

Authorizationstring required

Session JWT from POST /v0/auth/token, sent as Authorization: Bearer <sessionJwt>.

See Authentication for more details.

Response

OK

idstring uuid required

Deterministic route UUID; same canonical inputs always derive the same id.

namestring nullable

User-set label, or null when unset.

createdAtstring date-time required

Changes

Changed in 1 of the 3 revisions of this API.2

    • added the new account_not_provisioned enum value to the code response property for the response status 403

      response-property-enum-value-added

    • added the new account_verification_pending enum value to the code response property for the response status 403

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog