Skip to content

SDK method

tools.getJourney

Get journey details. Convenience alias for get_journey, forwarding to tinbox.api.journeys.get.query.

Signature

ts
getJourney(input: Parameters<TinboxTools["getJourney"]>[0]): ReturnType<TinboxTools["getJourney"]>

Parameters

NameTypeRequiredDescription
idstringyesThe journey id.

Returns

ReturnType<TinboxTools["getJourney"]>

Example

ts
await tinbox.tools.getJourney({
  "id": "<id>"
});