Get Open Journeys

Open journeys will be open to leads moved from different sources (For eg., other journeys). Using this API you can get the list of open journeys created in your organization.

Scope required

  • ZohoMarketingAutomation.journey.READ

Header:

Authorization: Zoho-oauthtoken <access_token>

Request type:

  • GET

Request URL

https://marketingautomation.zoho.com/api/v1/journeys?details={key-value pairs}

API Limit

  • Duration: 5 mins
  • Number of Calls: 100
  • Lock Period: 30 mins

You can send 100 API calls per 5 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.

List of parameters

ParameterData typeDescription
detailsJSON

It is a JSONObject containing key-value data of the following details:

  • page
  • limit
  • sort_order
  • user
  • trigger_type

 

Key-value pair description

ParameterData typeDescription
pageNumberProvide specific page number
limitNumberNumber of entities per page.
sort_orderStringascending or descending (asc/desc)
userString

If you want to list triggers created by

  • my (your list triggers)
  • all
  • other (others' list trigger)

 

trigger_typeStringopen

* - Mandatory parameters

Possible error cases

Error codeDescription
9008No such trigger exist
9001No journey matches the given criteria

If your error code is not listed above, click here.

Sample request

Copiedhttps://marketingautomation.zoho.com/api/v1/journeys?details={"page":"1","limit":"5","sort_order":"asc","user":"all","trigger_type":"open"}

Sample Response

Copied{
    "journeys": [
        {
            "created_time": "2019-03-11T11:28:34+05:30",
            "journey_key": "9bb77af841821fa7767e402a0f250219",
            "triggerkey": "9bb77af841821fa704a13363331fd551",
            "journey_name": "Latestopentrigger"
        },
        {
            "created_time": "2019-03-08T07:53:14+05:30",
            "journey_key": "9bb77af841821fa73ce137c1970c6a55",
            "trigger_key": "9bb77af841821fa7011c34c6de7e985f",
            "journey_name": "opentrigger"
        }
    ],
    "code": "200",
    "limit": 5,
    "sortorder": "asc",
    "page": 1,
    "message": "Success",
    "uri": "/api/v1/journeys",
    "version": "1"
}