# List journeys

List journeys under the specified folder.

Endpoint: GET /entities/journeys
Version: 1.0.0
Security: TdApikeyAuth

## Query parameters:

  - `folder_id` (integer, required)
    Folder ID specifying the folder where journeys are listed

  - `permission` (string)
    Permission to filter
    Enum: "view", "edit"

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string, required)

  - `data.type` (string, required)
    Enum: "journey"

  - `data.attributes` (object, required)

  - `data.attributes.audienceId` (string, required)

  - `data.attributes.name` (string, required)

  - `data.attributes.description` (string,null, required)

  - `data.attributes.state` (string, required)
    Enum: "draft", "simulation", "launched"

  - `data.attributes.goal` (object,null, required)

  - `data.attributes.goal.name` (string, required)

  - `data.attributes.goal.description` (string)

  - `data.attributes.goal.segmentId` (string, required)

  - `data.attributes.goal.target` (object)

  - `data.attributes.goal.target.journeyId` (string, required)

  - `data.attributes.goal.target.journeyStageId` (string, required)

  - `data.attributes.goal.target.journeyBundleId` (string,null)

  - `data.attributes.goal.target.stageOrderIndex` (integer,null)

  - `data.attributes.goal.target.jumpReferenceId` (string,null)
    The reference id of the jump target. This is used to identify the jump entity in the included field.

  - `data.attributes.createdAt` (string, required)

  - `data.attributes.updatedAt` (string, required)

  - `data.attributes.journeyStages` (array, required)

  - `data.attributes.journeyStages.id` (string)

  - `data.attributes.journeyStages.name` (string, required)

  - `data.attributes.journeyStages.description` (string)

  - `data.attributes.journeyStages.steps` (object,null)

  - `data.attributes.journeyStages.steps.uuid` (any) — one of:
    - JourneyActivationStep:
      - `type` (any, required)
        Enum: "Activation"
      - `name` (string, required)
      - `journeyActivationStepId` (string, required)
      - `next` (string)
    - JourneyDecisionPointStep:
      - `type` (any, required)
        Enum: "DecisionPoint"
      - `name` (string, required)
      - `branches` (array, required)
    - JourneyMergeStep:
      - `type` (any, required)
        Enum: "Merge"
      - `name` (string)
      - `next` (string)
    - JourneyJumpStep:
      - `type` (any, required)
        Enum: "Jump"
      - `name` (string, required)
      - `target` (object, required)
    - JourneyEndStep:
      - `type` (any)
        Enum: "End"
      - `name` (string)
    - JourneyAbTestStep:
      - `type` (any, required)
        Enum: "AbTest"
      - `name` (string, required)
      - `customizedSplit` (boolean, required)
      - `uniqueId` (string)
      - `variants` (array, required)

  - `data.attributes.journeyStages.rootStep` (string)

  - `data.attributes.journeyStages.entryCriteria` (object,null)

  - `data.attributes.journeyStages.milestone` (object,null)

  - `data.attributes.journeyStages.exitCriterias` (array)

  - `data.attributes.paused` (boolean, required)

  - `data.attributes.pausedAt` (string,null, required)

  - `data.attributes.allowReentry` (boolean, required)

  - `data.attributes.reentryMode` (string)
    Enum: "no_reentry", "reentry_unless_goal_achieved", "reentry_always"

  - `data.attributes.journeyBundleId` (string,null)

  - `data.attributes.journeyBundleName` (string,null)

  - `data.attributes.versionNumber` (integer)

  - `data.attributes.journeyBundleDescription` (string,null)

  - `data.attributes.latestExecution` (object,null)
    The most recent execution of the journey workflow. If no executions have been created, this will be null.

  - `data.attributes.latestExecution.workflowId` (string, required)

  - `data.attributes.latestExecution.workflowSessionId` (string, required)

  - `data.attributes.latestExecution.createdAt` (string, required)

  - `data.attributes.latestExecution.finishedAt` (string,null, required)

  - `data.attributes.latestExecution.status` (string, required)
    Enum: "success", "canceled", "error", "canceling", "blocked", "queued", "running"

  - `data.attributes.latestExecution.workflowAttemptId` (string, required)

  - `data.relationships` (object, required)

  - `data.relationships.parentFolder` (object)

  - `data.relationships.parentFolder.data` (object)

  - `data.relationships.parentFolder.data.id` (string, required)

  - `data.relationships.parentFolder.data.type` (string, required)
    Enum: "folder-segment"

  - `data.relationships.createdBy` (object)

  - `data.relationships.createdBy.data` (object,null)

  - `data.relationships.createdBy.data.id` (string, required)

  - `data.relationships.createdBy.data.type` (string, required)
    Enum: "user"

  - `data.relationships.updatedBy` (object)

  - `included` (array, required) — one of:
    - JourneyJumpFromJourney:
      - `id` (string, required)
      - `type` (string, required)
        Enum: "journey", "journeyStage"
      - `attributes` (object)
      - `attributes.name` (string, required)
      - `attributes.jumpType` (string)
      - `attributes.jumpName` (string,null)
      - `attributes.sourceJourneyId` (string)
      - `attributes.folderName` (string)
      - `attributes.targetJourneyId` (string)
      - `attributes.targetStageId` (string)
      - `attributes.targetStageName` (string)
      - `attributes.deletedBy` (string,null)
    - UserJsonApiResource:
      - `id` (string, required)
      - `type` (string, required)
        Enum: same as `data.relationships.createdBy.data.type` (1 values)
      - `attributes` (object, required)
      - `attributes.tdUserId` (string, required)
      - `attributes.name` (string, required)
    - JourneyActivationStepJsonApiResource:
      - `id` (string, required)
      - `type` (string, required)
        Enum: "journeyActivationStep"
      - `attributes` (object, required)
      - `attributes.activationId` (string,null, required)
      - `attributes.activationParams` (object, required)
      - `attributes.activationParams.name` (string, required)
      - `attributes.activationParams.description` (string)
      - `attributes.activationParams.allColumns` (boolean)
        syndication all column flag  ('true' means  that you use all attribute data)
      - `attributes.activationParams.columns` (array)
        Syndication column detail. Basic syntax is {"column": "alias_name", "source": {...}}. source accepts various definitions. See ColumnExpression/StringExpression for details. example value is using ColumnExpression without function property.
        Example: [{"column":"alias_name","source":{"column":"real_column_name"}}]
      - `attributes.activationParams.columns.id` (string)
      - `attributes.activationParams.columns.column` (string, required)
      - `attributes.activationParams.columns.source` (any, required) — one of:
        - ColumnExpression:
          - `column` (string, required)
          - `customerGroup` (string,null)
          - `functions` (array,null) — one of:
            - variant 1:
              - `function` (string, required)
                Enum: "+", "-", "*", "/"
              - `arg` (number)
            - variant 2:
              - `function` (string, required)
                Enum: "replace"
              - `search` (string)
              - `replacement` (string,null)
            - variant 3:
              - `function` (string, required)
                Enum: "substr"
              - `start` (number)
              - `length` (number)
            - variant 4:
              - `function` (string, required)
                Enum: "regexp_extract"
              - `pattern` (string)
              - `group` (number)
            - variant 5:
              - `function` (string, required)
                Enum: "day_of_week", "from_iso8601_timestamp", "ln", "elapsed_days", "td_ip_to_least_specific_subdivision_name", "td_ip_to_country_name", "td_ip_to_city_name", "td_ip_to_connection_type", "td_ip_to_domain"
            - variant 6:
              - `function` (string, required)
                Enum: "cast_as_quantitative"
              - `default` (number, required)
            - variant 7:
              - `function` (string, required)
                Enum: "cast_as_categorical"
              - `default` (string, required)
            - variant 8:
              - `function` (string, required)
                Enum: "cast_as_categorical_array"
            - variant 9:
              - `function` (string, required)
                Enum: "if"
              - `op` (string)
                Enum: ">", "<", "<=", ">=", "=", "!=", "is", "is\\", "not"
              - `right_value` (number,null)
              - `then` (number)
              - `else` (number)
        - StringExpression:
          - `string` (string, required)
          - `parameters` (array) — one of:
            Values for the placeholders ($1, $2, $3, ...) in the string
            - variant 1:
              - `type` (string)
                Enum: "String"
              - `string` (string)
            - variant 2:
              - `type` (string)
                Enum: "Timestamp"
              - `format` (string)
            - variant 3:
              - `type` (string)
                Enum: "SegmentName", "SegmentId", "AudienceId", "FunnelName", "StageName"
      - `attributes.activationParams.scheduleType` (string)
        Enum: "cron", "daily", "hourly", "minutes_interval", "monthly", "none", "weekly"
      - `attributes.activationParams.scheduleOption` (string)
      - `attributes.activationParams.runAt` (string)
      - `attributes.activationParams.cron` (string)
      - `attributes.activationParams.timezone` (string)
      - `attributes.activationParams.startAt` (string,null)
        cdp-api will fill some value for old syndications with ScheduleType is not NoneType. '%Y-%M-%DT%h:%m:%s' is expected.
      - `attributes.activationParams.endOn` (string,null)
      - `attributes.activationParams.repeatUnit` (string)
        Setting an activation repetition cycle such as "day" or "week".
        Enum: "none", "minute", "hour", "day", "week", "month", "once"
      - `attributes.activationParams.repeatFrequency` (integer)
        Setting an activation repeat frequency.
Currently, it is set only when the repeat unit is "minute". If the repeat unit is "minute", the interval is set in minutes.
      - `attributes.activationParams.connectionId` (string,null, required)
      - `attributes.activationParams.connectorConfig` (object,null, required)
      - `attributes.activationParams.notifyOn` (array)
        Enum: "onSuccess", "onFailure"
      - `attributes.activationParams.emailRecipients` (array)
      - `attributes.activationParams.activationTemplateId` (string)
      - `attributes.activationParams.nestedWorkflowProjectName` (string)
      - `attributes.activationParams.nestedWorkflowName` (string)
      - `attributes.activationParams.lockEnabled` (boolean)
      - `attributes.activationParams.activationActionsEnabled` (boolean)
      - `attributes.activationParams.syndicationBehavior` (object,null)
      - `attributes.activationParams.syndicationBehavior.columns` (array)
        Syndication column detail. Basic syntax is {"column": "alias_name", "source": {...}}. source accepts various definitions. See ColumnExpression/StringExpression for details. example value is using ColumnExpression without function property.
        Example: [{"column":"alias_name","source":{"column":"real_column_name"}}]
      - `attributes.activationParams.syndicationBehavior.behaviorTableName` (string)
        Behavior table name which contains behavior records
        Example: "purchase_history"
      - `attributes.activationParams.syndicationBehavior.joinRow` (integer,null)
        How much rows would be joined (value is N for Top-N join)
        Example: 3
      - `attributes.activationParams.syndicationBehavior.joinStrategy` (string)
        Enum: "All", "First", "Last", "Top-N"
      - `attributes.activationParams.syndicationBehavior.formatting` (string)
        Enum: "rows", "cols"
      - `attributes.activationParams.syndicationBehavior.orderBy` (array)
        Example: [{"key":"purchased_at","order":"descending"},{"key":"price","order":"ascending"}]
      - `attributes.activationParams.syndicationBehavior.orderBy.key` (string)
        Example: "purchased_at"
      - `attributes.activationParams.syndicationBehavior.orderBy.order` (string)
        Enum: "ascending", "descending"
      - `relationships` (object, required)
      - `relationships.createdBy` (object)
      - `relationships.updatedBy` (object)