---
title: "Retrieve parent segment configuration by ID"
method: GET
path: "/audiences/{audienceId}"
tags: ["Parent Segment Configurations"]
---

# Retrieve parent segment configuration by ID

`GET /audiences/{audienceId}`

Search and find a specified parent segment configuration by its identifier.

## Path parameters

- `audienceId` integer, required

## Response `200`

successful operation

- union
  - Audience — An audience handles a Master Segment and a related Master Segment Config.
    - `id` string, integer
    - `name` string, required
    - `description` string
    - `scheduleType` 'cron' | 'daily' | 'hourly' | 'minutes_interval' | 'monthly' | 'none' | 'weekly'
    - `scheduleOption` string, nullable
    - `timezone` string
    - `matrixUpdatedAt` string, datetime, nullable
    - `workflowHiveOnly` boolean — Whether the workflow mainly use Hive or not. Default is false
    - `hiveEngineVersion` '0.13' | 'cdpaudience' — Hive engine version used in audience workflows
    - `hivePoolName` string, nullable
    - `prestoPoolName` string, nullable
    - `allowActivationBehavior` boolean, nullable
    - `maxActivationBehaviorRow` integer, nullable — Only null is acceptable when allowActivationBehavior is false.
    - `llmEnabled` boolean, nullable — llmEnabled indicates whether customer has enabled llm (true or false).
    - `llmState` 'enabling' | 'enabled' | 'disabling' | 'disabled' — llmState indicates more detailed state including updating.
    - `population` integer, nullable — the population of the audience
    - `enrichmentWordTaggingEnabled` boolean
    - `enrichmentIpEnabled` boolean
    - `enrichmentTdJsSdkEnabled` boolean
    - `master` AudienceMaster
      - `parentDatabaseName` string, required — Source database name of the audience master
      - `parentTableName` string, required — Source table name of the audience master
    - `attributes` AudienceAttribute[]
      - `audienceId` string, required — ID of Master Segment for this attribute
      - `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
      - `parentDatabaseName` string, required — Database name of the attribute table
      - `parentTableName` string, required — Table name of the attribute table
      - `parentColumn` string, required — Column name of the attribute table which is imported into customer table
      - `parentKey` string, required — Join key of the attribute table
      - `foreignKey` string, required — Foreign key of the master table
      - `groupingName` string, nullable, required — Group name of the attribute
    - `behaviors` AudienceBehavior[]
      - `id` string, required — ID of Master Segment Config behavior
      - `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
      - `schema` AudienceBehaviorSchema[], 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, required — Column name of the behavior table
      - `scheduleType` 'cron' | 'daily' | 'hourly' | 'minutes_interval' | 'monthly' | 'none' | 'weekly'
      - `scheduleOption` string, nullable
      - `defaultTimeFilterEnabled` boolean
      - `isRealtime` boolean
    - `customerGroup` CustomerGroup — A group of customers within an audience
      - `id` string
      - `audienceId` integer
      - `name` string, required — group name that is to be used for table name
      - `parentDatabaseName` string, required — Database name of the customer_group table
      - `parentTableName` string, required — Table name of the customer_group table
      - `parentKey` string, required — Join key of the customer_group table
      - `foreignKey` string, required — Foreign key of the customers table
      - `customerGroupAttributes` CustomerGroupAttribute[]
        - `name` string, required — Column name
        - `type` 'string' | 'number' | 'timestamp' | 'date' | 'string_array' | 'number_array' | 'boolean', required — Type of the column
        - `parentDatabaseName` string, required — Database name of the customer_group attribute table
        - `parentTableName` string, required — Table name of the customer_group attribute table
        - `parentColumn` string, required — Column name of the customer_group attribute table which is imported into customer table
        - `parentKey` string, required — Join key of the customer_group attribute table
        - `foreignKey` string, required — Foreign key of the customer_group table
      - `customerGroupBehaviors` CustomerGroupBehavior[]
        - `name` string, required — Behavior name
        - `parentDatabaseName` string, required — Database name of the customer_group behavior table
        - `parentTableName` string, required — Table name of the customer_group behavior table
        - `parentKey` string, required — Join key of the customer_group behavior table
        - `foreignKey` string, required — Foreign key of the customer_group table
        - `schema` CustomerGroupBehaviorSchema[], required — Columns of behavior
          - `name` string, required — Column name
          - `type` 'string' | 'number' | 'timestamp' | 'date' | 'string_array' | 'number_array' | 'boolean', required — Type of the column
          - `parentColumn` string, required — Column name of the customer_group behavior table
    - `audienceFilters` AudienceFilter[]
      - `columnName` string, required — Column name to filter source data
      - `rightValues` string[], required — Values of the column to filter source data
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `createdBy` User
      - `id` string
      - `td_user_id` string
      - `name` string
    - `updatedBy` User
      - `id` string
      - `td_user_id` string
      - `name` string
  - ComposableAudience — A composable audience for zero-copy segments using CDW tables via federated queries (Snowflake) or direct connections (Databricks). Exactly one of federatedQueryConfigId or connectionId must be provided.
    - `id` string, integer
    - `name` string, required
    - `description` string, nullable
    - `federatedQueryConfigId` string, integer — Federated query config ID for Snowflake. Mutually exclusive with connectionId.
    - `connectionId` string, integer — Connection ID for Databricks. Mutually exclusive with federatedQueryConfigId.
    - `masterCatalog` string, nullable — Catalog name for the master table. Required for Databricks, null for Snowflake.
    - `masterSchema` string, required
    - `masterTable` string, required
    - `masterKeyColumn` string
    - `timezone` string, required
    - `allowActivationBehavior` boolean — whether activation behaviors are allowed for this audience
    - `maxActivationBehaviorRow` integer — maximum number of activation behavior rows
    - `isComposable` boolean
    - `kind` 'composable'
    - `attributes` ComposableAudienceAttribute[]
      - `id` string, integer
      - `name` string, required
      - `federatedQueryConfigId` string, integer — Federated query config ID for Snowflake. Mutually exclusive with connectionId.
      - `connectionId` string, integer — Connection ID for Databricks. Mutually exclusive with federatedQueryConfigId.
      - `schema` string, required
      - `table` string, required
      - `tableKey` string, required
      - `masterKey` string, required
      - `column` string, required
      - `type` 'string' | 'number' | 'timestamp' | 'date' | 'string_array' | 'number_array' | 'boolean' — Type of the column
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
    - `behaviors` ComposableAudienceBehavior[]
      - `id` string, integer
      - `name` string, required
      - `federatedQueryConfigId` string, integer — Federated query config ID for Snowflake. Mutually exclusive with connectionId.
      - `connectionId` string, integer — Connection ID for Databricks. Mutually exclusive with federatedQueryConfigId.
      - `schema` string, required
      - `table` string, required
      - `tableKey` string, required
      - `masterKey` string, required
      - `timeColumn` string
      - `columnMapping` object[], required
        - `name` string, required
        - `type` 'string' | 'number' | 'timestamp' | 'date' | 'string_array' | 'number_array' | 'boolean' — Type of the column
        - `cdwColumn` string, required
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
    - `population` integer, nullable — the population of the composable audience
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `createdBy` User
      - `id` string
      - `td_user_id` string
      - `name` string
    - `updatedBy` User
      - `id` string
      - `td_user_id` string
      - `name` string

## Other responses

- `400` — Given parameters are not valid
- `401` — Unauthorized; You don't provide valid credentials. Maybe you didn't specify valid TD's Master API Key as 'TD1 {Your TD Master API Key}'.
- `403` — Requested resource or action is not allowed because you don't have sufficient permissions
- `404` — The specified resource was not found
- `4XX` — There is a high possibility of error of the authentication system. Please check the contents and authority of the key. Please contact the TD support team if you do not resolve it.
- `5XX` — System error. Because there is a possibility of a temporary error due to network trouble and so on, we recommend several times retry on request side. Please contact the TD support team if you do not resolve it.

---

[API](https://skmtc.net/treasure/apis/cdp-api.md) · [All operations](https://skmtc.net/treasure/apis/cdp-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/treasure/cdp-api/revisions/24caa8eb809b/schema)