---
title: "Retrieve a list of available behavior table of specified step"
method: POST
path: "/entities/journeys/{journeyId}/available_behaviors_for_step"
tags: ["Journeys"]
---

# Retrieve a list of available behavior table of specified step

`POST /entities/journeys/{journeyId}/available_behaviors_for_step`

## Request

- Base URL: `https://api-cdp.treasuredata.com`
- URL: `https://api-cdp.treasuredata.com/entities/journeys/{journeyId}/available_behaviors_for_step`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/treasure/apis/cdp-api/docs/entities/journeys/:journeyId/available_behaviors_for_step/post.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of available behavior table of specified step.

## Path parameters

- `journeyId` integer, required

## Query parameters

- `stepId` string, uuid

## Request body

- EntitiesJourneyUpdateRepresentation
  - `type` 'journey'
  - `attributes` object
    - `name` string, required
    - `description` string, nullable
    - `state` 'draft' | 'simulation' | 'launched'
    - `goal` JourneyCriteria, nullable
      - `name` string, required
      - `description` string
      - `segmentId` string, required
      - `target` JourneyJumpTarget
        - `journeyId` string, required: ID of an existing journey to jump to.
        - `journeyStageId` string, required: ID of an existing stage within the target journey to jump to.
        - `journeyBundleId` string, nullable
        - `stageOrderIndex` integer, nullable
        - `jumpReferenceId` string, nullable: The reference id of the jump target. This is used to identify the jump entity in the included field.
    - `journeyStages` JourneyStageJsonApiResource[]
      - `id` string: Server-generated. Omit when creating a stage; supply to target an existing stage when updating.
      - `name` string, required
      - `description` string
      - `steps` JourneyStep, nullable
        - `uuid` union
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - JourneyActivationStep
            - `type` 'Activation', required
            - `name` string, required
            - `journeyActivationStepId` string, required
            - `next` string
          - JourneyDecisionPointStep
            - `type` 'DecisionPoint', required
            - `name` string, required
            - `branches` JourneyDecisionPointBranch[], required
              - …
          - JourneyMergeStep
            - `type` 'Merge', required
            - `name` string
            - `next` string
          - JourneyJumpStep
            - `type` 'Jump', required
            - `name` string, required
            - `target` JourneyJumpTarget, required
              - …
          - JourneyEndStep, nullable
            - `type` 'End'
            - `name` string
          - JourneyAbTestStep
            - `type` 'AbTest', required
            - `name` string, required
            - `customizedSplit` boolean, required
            - `uniqueId` string
            - `randomizationMode` 'sticky' | 'reentry' | 'periodic', nullable: Controls how variant assignments behave on re-entry. "sticky" (default): deterministic assignment, same variant on every entry. "reentry": fresh random assignment on each re-entry. "periodic": assignment stable within cadence window, re-randomized at boundary.
            - `periodicCadence` 'weekly' | 'monthly' | 'yearly': Required when randomizationMode is "periodic". Defines the cadence at which variant assignments reset.
            - `periodicBoundaryMonth` integer: Required when periodicCadence is "yearly". Month of the reset boundary (1-12).
            - `periodicBoundaryDay` integer: Required when periodicCadence is "monthly" or "yearly". Day of the reset boundary (1-31). If the specified day exceeds the number of days in a given month, the last day of that month is used.
            - `periodicBoundaryDayOfWeek` integer: Required when periodicCadence is "weekly". Day of the reset boundary using ISO-8601 numbering (1=Monday, 7=Sunday).
            - `enabledCapping` boolean: Enables profile capping on the step
            - `winnerVariantId` string, nullable: Set when a winner variant is declared via PATCH .../ab_test_winner. Response-only; cannot be set through a journey create/update request.
            - `variants` JourneyAbTestVariant[], required
              - …
      - `rootStep` string
      - `entryCriteria` JourneyCriteria, nullable
        - `name` string, required
        - `description` string
        - `segmentId` string, required
        - `target` JourneyJumpTarget
          - `journeyId` string, required: ID of an existing journey to jump to.
          - `journeyStageId` string, required: ID of an existing stage within the target journey to jump to.
          - `journeyBundleId` string, nullable
          - `stageOrderIndex` integer, nullable
          - `jumpReferenceId` string, nullable: The reference id of the jump target. This is used to identify the jump entity in the included field.
      - `milestone` JourneyCriteria, nullable
        - `name` string, required
        - `description` string
        - `segmentId` string, required
        - `target` JourneyJumpTarget
          - `journeyId` string, required: ID of an existing journey to jump to.
          - `journeyStageId` string, required: ID of an existing stage within the target journey to jump to.
          - `journeyBundleId` string, nullable
          - `stageOrderIndex` integer, nullable
          - `jumpReferenceId` string, nullable: The reference id of the jump target. This is used to identify the jump entity in the included field.
      - `exitCriterias` JourneyCriteria[]
        - `name` string, required
        - `description` string
        - `segmentId` string, required
        - `target` JourneyJumpTarget
          - `journeyId` string, required: ID of an existing journey to jump to.
          - `journeyStageId` string, required: ID of an existing stage within the target journey to jump to.
          - `journeyBundleId` string, nullable
          - `stageOrderIndex` integer, nullable
          - `jumpReferenceId` string, nullable: The reference id of the jump target. This is used to identify the jump entity in the included field.
    - `allowReentry` boolean
    - `reentryMode` 'no_reentry' | 'reentry_unless_goal_achieved' | 'reentry_always'
    - `journeyBundleId` string, nullable: Attach the journey to an existing journey bundle as its next version.
    - `journeyBundleName` string, nullable
    - `journeyBundleDescription` string, nullable

## Response `200`

Returns a list of available behavior table of specified journey

- EntitiesAudienceBehaviorIndexJsonApiResponse
  - `data` AudienceBehaviorWithVisibilityJsonApiResource[], required
    - `id` string, required
    - `type` 'audience-behavior', required
    - `attributes` object, required
      - `audienceId` string, required
      - `name` string, required: Behavior name user defined on Master Segment Configuration page of Data Workbench
      - `parentDatabaseName` string, required: Database name of the behavior table
      - `parentTableName` string, required: Table name of the behavior table
      - `parentKey` string, required: Join key of the behavior table
      - `foreignKey` string, required: Foreign key of the master table
      - `matrixDatabaseName` string, required: Matrix database name of the behavior table
      - `matrixTableName` string, required: Matrix table name of the behavior table
      - `allColumns` boolean, required
      - `defaultTimeFilterEnabled` boolean, required
      - `isRealtime` boolean, required
      - `schema` AudienceBehaviorSchemaWithVisibility[], required: Columns of behavior
        - `name` string, required: Column name user defined on Master Segment Configuration page of Data Workbench
        - `type` 'string' | 'number' | 'timestamp' | 'date' | 'string_array' | 'number_array' | 'boolean', required: Type of the column
        - `parentColumn` string, nullable, required: Column name of the behavior table (This can be null when the column is an enriched column)
        - `matrixColumnName` string: Column name of the behavior table
        - `matrixColumnDescription` string, nullable: Description of the column in behavior table
        - `visibility` 'clear' | 'pii' | 'non_pii' | 'blocked'

## Changes

- **2026-09-09** `c7cbe63450a3`: 5 info
  - added the new optional request property `attributes/journeyStages/items/steps/uuid/oneOf[#/components/schemas/JourneyAbTestStep]/periodicBoundaryDay`
  - added the new optional request property `attributes/journeyStages/items/steps/uuid/oneOf[#/components/schemas/JourneyAbTestStep]/periodicBoundaryDayOfWeek`
  - added the new optional request property `attributes/journeyStages/items/steps/uuid/oneOf[#/components/schemas/JourneyAbTestStep]/periodicBoundaryMonth`
  - added the new optional request property `attributes/journeyStages/items/steps/uuid/oneOf[#/components/schemas/JourneyAbTestStep]/periodicCadence`
  - …1 more
- **2026-08-14** `f5ae81d77da9`: 1 info
  - added the new optional request property `attributes/journeyStages/items/steps/uuid/oneOf[#/components/schemas/JourneyAbTestStep]/randomizationMode`

[Operation history](https://skmtc.dev/treasure/apis/cdp-api/changes/entities/journeys/:journeyId/available_behaviors_for_step/post.md)

---

[API](https://skmtc.dev/treasure/apis/cdp-api.md) - [All operations](https://skmtc.dev/treasure/apis/cdp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/treasure/apis/cdp-api/revisions/2989992e9ba2?raw)