# Retrieve a list of realtime journeys under the Parent Segment

Retrieve a list of realtime journeys under the Parent Segment

Endpoint: GET /entities/parent_segments/{parentSegmentId}/realtime_journeys
Version: 1.0.0
Security: TdApikeyAuth

## Path parameters:

  - `parentSegmentId` (integer, required)
    Parent Segment ID (audience id)

## Query parameters:

  - `page[size]` (number)
    The maximum number of results to return per page

  - `page[after]` (string)
    A string to fetch more page. The next value should be present at the pagination.nextPage in the previous response if more pages exist.

  - `permissions` (string)
    filter by the resource's permission. Default to 'view'
    Enum: "edit", "view"

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string)

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

  - `data.attributes` (object)

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

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

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

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

  - `data.attributes.goal` (any, required)
    - `name` (string, required)
    - `description` (string)
    - `keyEventCriteria` (object)
    - `keyEventCriteria.keyEventId` (string)
    - `keyEventCriteria.keyEventFilters` (object)
      TODO: something like ION?
    - `keyEventCriteria.keyEventFilters.todo` (string)
    - `profileCriteria` (object)
    - `acceptUnknownProfiles` (boolean,null)
    - `target` (object,null)
    - `target.realtimeJourneyId` (string, required)
    - `target.realtimeJourneyStageId` (string, required)
    - `target.confirmed` (boolean, required)

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

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

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

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

  - `data.attributes.realtimeJourneyStages.steps` (object)
    Example: {"58AB9022-B48D-430A-A879-2E13D08CD2C1":{"type":"WaitStep","name":"Wait 1 hour","waitStep":1,"waitStepUnit":"hour","next":"428CA341-3C3E-4D38-8D88-A035CE83A1FF"},"428CA341-3C3E-4D38-8D88-A035CE83A1FF":{"type":"TriggeredActivation","name":"Send mail","journeyActivationStepId":"123"}}

  - `data.attributes.realtimeJourneyStages.rootStep` (string,null)
    Example: "58AB9022-B48D-430A-A879-2E13D08CD2C1"

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

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

  - `data.attributes.realtimeJourneyStages.entryCriteria.description` (string)

  - `data.attributes.realtimeJourneyStages.entryCriteria.keyEventCriteria` (object)

  - `data.attributes.realtimeJourneyStages.entryCriteria.keyEventCriteria.keyEventId` (string)

  - `data.attributes.realtimeJourneyStages.entryCriteria.keyEventCriteria.keyEventFilters` (object)
    TODO: something like ION?

  - `data.attributes.realtimeJourneyStages.entryCriteria.keyEventCriteria.keyEventFilters.todo` (string)

  - `data.attributes.realtimeJourneyStages.entryCriteria.profileCriteria` (object)

  - `data.attributes.realtimeJourneyStages.entryCriteria.acceptUnknownProfiles` (boolean,null)

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

  - `data.attributes.realtimeJourneyStages.exitCriterias` (array) — one of:
    - partial_realtime_journey.yaml-RealtimeJourneyStaleCriteria:
      - `name` (string,null)
      - `unit` (string)
        Enum: "minute", "hour", "day"
      - `exitAfter` (integer)
    - partial_realtime_journey.yaml-RealtimeJourneyCustomExitCriteria:
      - `name` (string,null, required)
      - `keyEventCriteria` (object, required)
      - `profileCriteria` (object, required)
      - `target` (object,null, required)
      - `target.realtimeJourneyId` (string, required)
      - `target.realtimeJourneyStageId` (string, required)
      - `target.confirmed` (boolean, required)

  - `data.attributes.realtimeJourneyStages.orderIndex` (integer)

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

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

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

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

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

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

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

  - `data.relationships` (object)

  - `data.relationships.createdBy` (object)

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

  - `data.relationships.createdBy.td_user_id` (string)

  - `data.relationships.createdBy.name` (string)

  - `data.relationships.updatedBy` (object)

  - `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.realtimeJourneyActivationSteps` (object)

  - `data.relationships.realtimeJourneyActivationSteps.data` (array, required)

  - `data.relationships.realtimeJourneyActivationSteps.data.id` (string)

  - `data.relationships.realtimeJourneyActivationSteps.data.type` (string)
    Enum: "realtime-journey-activation-step"

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes` (object)

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes.name` (string)

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes.description` (string,null)

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes.stepUuid` (string)

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes.connectionId` (string, required)

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes.connectorType` (string, required)

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes.connector` (object, required)

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes.connector.exportJson` (string,null)

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes.connector.exportAdvancedJson` (string,null)

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes.realtimeJourneyId` (string)

  - `data.relationships.realtimeJourneyActivationSteps.data.attributes.realtimeJourneyStageId` (string,null)
    null until used in the RT Journey

  - `data.relationships.realtimeJourneyActivationSteps.meta` (object, required)

  - `data.relationships.realtimeJourneyActivationSteps.meta.names` (object)

  - `data.relationships.jumpLinks` (object)

  - `data.relationships.jumpLinks.data` (array, required)

  - `data.relationships.jumpLinks.data.id` (string)

  - `data.relationships.jumpLinks.data.type` (string)
    Enum: "realtime-journey-jump-link"

  - `data.relationships.jumpLinks.meta` (object, required)

  - `data.relationships.jumpLinks.meta.targetStageInfo` (object)

  - `data.relationships.jumpFroms` (object)

  - `data.relationships.jumpFroms.data` (array, required)

  - `data.relationships.jumpFroms.meta` (array, required)

  - `data.relationships.jumpFroms.meta.sourceJourneyId` (string)

  - `data.relationships.jumpFroms.meta.sourceJourneyName` (string)

  - `data.relationships.jumpFroms.meta.sourceJourneyState` (string)
    Enum: same as `data.attributes.state` (2 values)

  - `data.relationships.jumpFroms.meta.sourceJourneyStageId` (string,null)
    null only when jump from goal

  - `data.relationships.jumpFroms.meta.sourceJourneyStageName` (string,null)
    null only when jump from goal

  - `data.relationships.jumpFroms.meta.sourceJourneyFolderId` (string)

  - `data.relationships.jumpFroms.meta.sourceJourneyFolderName` (string)

  - `data.relationships.jumpFroms.meta.targetJourneyStageId` (string)

  - `data.relationships.jumpFroms.meta.jumpFrom` (string)
    Enum: "exit_criteria", "jump_step", "goal"

  - `data.relationships.jumpFroms.meta.jumpName` (string)

  - `pagination` (object, required)

  - `pagination.nextPage` (string,null, required)
    The path part of URL of the next page