---
title: "Get Trace Pipeline"
method: POST
path: "/trace-pipeline/{id}/get-item"
tags: ["Trace Pipeline"]
---

# Get Trace Pipeline

`POST /trace-pipeline/{id}/get-item`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/trace-pipeline/{id}/get-item`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/trace-pipeline/:id/get-item/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a single Trace Pipeline by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` TracePipelineSelectSchema: Select schema for TracePipeline. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `name` boolean
    - `description` boolean
    - `filterQuery` boolean
    - `isEnabled` boolean
    - `sortOrder` boolean
    - `createdByUserId` boolean
    - `deletedByUserId` boolean

## Response `200`

Successful response

- object
  - `data` TracePipeline
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Trace Pipeline], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [Project Owner, Project Admin, Edit Trace Pipeline]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Trace Pipeline], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [Project Owner, Project Admin, Edit Trace Pipeline]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Trace Pipeline], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [Project Owner, Project Admin, Edit Trace Pipeline]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Trace Pipeline], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [Project Owner, Project Admin, Edit Trace Pipeline]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of the project this trace pipeline belongs to. Permissions - Create: [Project Owner, Project Admin, Create Trace Pipeline], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [No access - you don't have permission for this operation]
    - `name` string, required: Friendly name for this trace pipeline. Permissions - Create: [Project Owner, Project Admin, Create Trace Pipeline], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [Project Owner, Project Admin, Edit Trace Pipeline]
    - `description` string: Description of what this trace pipeline does. Permissions - Create: [Project Owner, Project Admin, Create Trace Pipeline], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [Project Owner, Project Admin, Edit Trace Pipeline]
    - `filterQuery` string: Filter expression that determines which spans this pipeline applies to. Permissions - Create: [Project Owner, Project Admin, Create Trace Pipeline], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [Project Owner, Project Admin, Edit Trace Pipeline]
    - `isEnabled` boolean, required: Whether this trace pipeline is active. Permissions - Create: [Project Owner, Project Admin, Create Trace Pipeline], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [Project Owner, Project Admin, Edit Trace Pipeline]
    - `sortOrder` number: Where this pipeline runs among the project's trace pipelines, lowest number first. A new pipeline is added to the end of the list. Setting a number another one already has puts it in that place, and the ones in the way move one place along to make room. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Create Trace Pipeline], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [Project Owner, Project Admin, Edit Trace Pipeline]
    - `createdByUserId` string, uuid: ID of the user who created this trace pipeline. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [No access - you don't have permission for this operation]
    - `deletedByUserId` string, uuid: ID of the user who deleted this trace pipeline. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Trace Pipeline], Update: [No access - you don't have permission for this operation]

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)