Retrieving your JourneyIds and ActorIds

The GET /api/v2/ci/journeys endpoint will return a list of all the Journeys that you have available to use (based on the API Key you are using).  Each Journey in the list will contain the following details:

{

    "id": "xxx",

    "title": "xxx",

    "description": "xxx",

    "endUserDescription": "xxx",

    "isPublic": false,

    "isActive": true,

    "webhookEnabled": false,

    "actors": [

      {

        "id": xx,

        "title": "xxx",

        "canAddMultiple": false,

        "isClient": false

      }

    ],

    "industries": [],

    "method": 0,

    "stepTypes": [

      1,

      2,

      11

    ],

    "showAllSummaryPages": true,

    "showIntroSummaryPage": true,

    "showJourneyDescriptionPage": false,

    "isRightToWork": false,

    "isRightToRent": false,

    "isSafeHarbour": false,

    "isAffordability": false

  }

The two highlighted values are important.  The first "id" is the journeyId, the second "id" (within the "actors" section) is the actorID.

Both journeyId and actorId will be required in order to create a new Process.

NOTE: Journeys can be configured with multiple actors - e.g. 'House Buyer' and 'House Seller' where multiple role types are required.  However, in the vast majority of cases, and for all public journeys, only one Actor is used.