---
title: "Get pipeline by ID"
method: GET
path: "/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}"
tags: ["Build and Configure Continuous Integration Projects"]
---

# Get pipeline by ID

`GET /v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}`

## Request

- Base URL: `https://integration-adapter.connect.cloud.precisely.com`
- URL: `https://integration-adapter.connect.cloud.precisely.com/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}`
- Auth: HTTP bearer

Retrieves a specific continuous data integration pipeline by its unique identifier.

**Features:**
- Complete pipeline information including metadata and configuration
- Optional connection and mapping details inclusion
- Optional configuration fields inclusion
- Pipeline existence validation
- Access control enforcement

**Response Content:**
- Pipeline metadata (name, description, type, timestamps)
- User information (creator, last modifier)
- Project association details
- Optional connection configurations if requested
- Optional table mapping configurations if requested
- Optional configuration fields (cdc row metadata/user databases)

**Optional Data Loading:**
- `includeConnections` - Include source and target connection details
- `includeMappings` - Include table mapping configurations and column mappings (default mappings may not be fully expanded)
- To fetch a fully resolved mapping (including default column mappings), use
  `GET /v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/mappings/{tableMappingId}`

**Use Cases:**
- View detailed pipeline information
- Check pipeline configuration and status
- Access pipeline-specific connection and mapping details

**Required Permissions:** `replication-pipeline::view`

## Path parameters

- `projectId` string, required
- `pipelineId` string, required

## Query parameters

- `includeConnections` boolean
- `includeMappings` boolean: Only effective when includeConnections=true
- `loadConfigs` boolean

## Response `200`

Successfully retrieved the pipeline

- ContinuousPipelineResponse: Response model containing pipeline information
  - `id` string: Unique identifier of the pipeline
  - `name` string: Name of the pipeline
  - `description` string: Description of the pipeline
  - `pipelineType` 'SYNCHRONIZE' | 'REPLICATE' | 'COPY': Type of the pipeline (e.g. COPY, REPLICATE, SYNCHRONIZE)
  - `projectId` string: Unique identifier of the project containing this pipeline
  - `source` ConnectionResponse: Data connection details used in pipelines
    - `id` string: Unique identifier of the connection
    - `name` string: Human readable connection name
    - `type` string: Connection type (e.g., DB2I, KAFKA, BIGQUERY)
    - `parameters` object: Connection configuration parameters as key-value pairs
  - `target` ConnectionResponse: Data connection details used in pipelines
    - `id` string: Unique identifier of the connection
    - `name` string: Human readable connection name
    - `type` string: Connection type (e.g., DB2I, KAFKA, BIGQUERY)
    - `parameters` object: Connection configuration parameters as key-value pairs
  - `staging` ConnectionResponse: Data connection details used in pipelines
    - `id` string: Unique identifier of the connection
    - `name` string: Human readable connection name
    - `type` string: Connection type (e.g., DB2I, KAFKA, BIGQUERY)
    - `parameters` object: Connection configuration parameters as key-value pairs
  - `userDatabases` UserDatabaseResponse[]: List of user databases prepared for this pipeline
    - `name` string: Name of the user database
    - `dataConnectionId` string: Identifier of the data connection backing the user database
  - `includedCDCRowMetadata` string[]: Metadata fields to include with change data records for all default table mappings in this pipeline
  - `createdAt` string, date-time: Timestamp when the pipeline was created
  - `properties` object: Additional configuration properties for the pipeline
  - `createdBy` string: Username of the pipeline owner
  - `modifiedAt` string, date-time: Timestamp when the pipeline was last modified
  - `modifiedBy` string: Username of the person who last modified the pipeline
  - `tableMappings` ContinuousTableMappingResponse[]: List of table mappings configured for this pipeline
    - `id` string: Unique identifier of the table mapping
    - `sourceDatabase` string: Name of the source database
    - `sourceSchema` string: Name of the source schema
    - `sourceTable` string: Name of the source table
    - `targetDatabase` string: Name of the target database
    - `targetSchema` string: Name of the target schema
    - `targetTable` string: Name of the target table
    - `targetTopic` string: Name of the target topic
    - `targetSubject` string: Name of the target subject for schema registry
    - `type` 'TARGET_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITHOUT_MATCH' | 'TARGET_DOES_NOT_EXIST' | 'BOTH_TARGET_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITHOUT_MATCH_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_DOES_NOT_EXIST_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITH_MATCH_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'BOTH_TARGET_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'TARGET_DOES_NOT_EXIST_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'TARGET_EXISTS_WITH_MATCH_AND_SUBJECT_DOES_NOT_EXIST' | 'TARGET_EXISTS_WITHOUT_MATCH_AND_SUBJECT_DOES_NOT_EXIST' | 'BOTH_TARGET_AND_SUBJECT_DOES_NOT_EXIST': Type of the table mapping
    - `hasCustomColMappings` boolean: Flag indicating whether the table has custom column mappings
    - `includedCDCRowMetadata` string[]: Metadata fields to include with change data records for this table mapping configuration, this overrides the Metadata fields defined at the pipeline level
    - `schemaVersion` string: Version of the schema used for this mapping
    - `softDeleteColumnName` string: Name of the column used for soft deletes
    - `columnMappings` ColumnMappingResponse[]: List of column mappings for this table
      - `sourceColumnName` string: Name of the source column
      - `targetColumnName` string: Name of the target column
      - `sourceColType` string: Data type of the source column
      - `targetColType` string: Data type of the target column
      - `isDistributionKey` boolean: Flag indicating if this column is used as a distribution key
      - `action` 'Copy' | 'Ignore' | 'SoftDelete': Action to be performed for this column mapping
      - `state` 'TARGET_COLUMN_DATATYPE_NOT_SUPPORTED' | 'SOURCE_COLUMN_DATATYPE_NOT_SUPPORTED' | 'BOTH_TARGET_AND_SOURCE_COLUMN_DATATYPE_NOT_SUPPORTED' | 'BOTH_TARGET_AND_SOURCE_COLUMN_DATATYPE_SUPPORTED' | 'SOURCE_COLUMN_DATATYPE_SUPPORTED' | 'TARGET_AND_SOURCE_COLUMN_DATATYPE_NOT_COMPATIBLE' | 'NOT_CHECKED': Current state of the column mapping
      - `sourceColumnNullableState` 'NULLABLE_WITH_DEFAULT_VALUE' | 'NULLABLE_WITHOUT_DEFAULT_VALUE' | 'NON_NULLABLE_WITH_DEFAULT_VALUE' | 'NON_NULLABLE_WITHOUT_DEFAULT_VALUE': Nullable state of the source column
      - `targetColumnNullableState` 'NULLABLE_WITH_DEFAULT_VALUE' | 'NULLABLE_WITHOUT_DEFAULT_VALUE' | 'NON_NULLABLE_WITH_DEFAULT_VALUE' | 'NON_NULLABLE_WITHOUT_DEFAULT_VALUE': Nullable state of the target column
      - `metadataMapping` boolean: Flag indicating if this is a change data records metadata mapping
      - `mappingType` 'FIELD' | 'EXPRESSION' | 'RRN': Type of mapping if this is FIELD / EXPRESSION / RRN

## Other responses

- `400`: Bad Request - Invalid pipeline ID format
- `403`: Forbidden - Insufficient permissions to access pipeline data
- `404`: Not Found - Pipeline with the specified ID does not exist
- `500`: Internal Server Error - Failed to retrieve pipeline

---

[API](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service.md) · [All operations](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/revisions/2d2629f4987d?raw)