---
title: "Get a pipeline"
url: https://docs.gleap.ai/en/reference/rest-api/get-pipeline
method: GET
path: "/pipelines/{pipelineId}"
api: "API Reference"
tag: "Pipelines"
operationId: "GetPipeline"
updatedAt: "2026-11-01T18:40:15.677Z"
language: en
---

# Get a pipeline

`GET https://api.gleap.io/v3/pipelines/{pipelineId}`

Get one pipeline by its id, including its stages (`lanes`) and column configuration. A pipeline holds records of exactly one type: companies or contacts (`recordType`).

## Authorization

- `Authorization` (header, required): `Bearer <token>`

## Path parameters

- `pipelineId` (string, required)

## Headers

- `project` (string, required)

## Example request

```bash
curl --request GET \
  --url 'https://api.gleap.io/v3/pipelines/{pipelineId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>'
```

## Responses

### 200 (`application/json`)

Ok

- `updatedAt` (string, required)
- `createdAt` (string, required)
- `sortBy` (any)
- `icon` (string)
- `color` (string)
- `organisation` (object)
  - `isValid` (object)
  - `createFromHexString` (object)
  - `createFromTime` (object)
  - `generate` (object)
  - `cacheHexString` (any)
  - `prototype` (string)
- `name` (string)
- `columns` (any[], required)
- `lanes` (any[], required)
- `recordType` (enum<string>, required): What a pipeline holds. Persisted values — never rename a member, only add. One of: `COMPANY`, `CONTACT`.
- `viewType` (enum<string>, required): One of: `board`, `table`.
- `isPublic` (boolean, required)
- `project` (object, required)
  - `isValid` (object)
  - `createFromHexString` (object)
  - `createFromTime` (object)
  - `generate` (object)
  - `cacheHexString` (any)
  - `prototype` (string)
- `users` (string[], required)
- `_id` (string, required)

```json
{
  "updatedAt": "string",
  "createdAt": "string",
  "icon": "string",
  "color": "string",
  "organisation": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {}
  },
  "name": "string",
  "columns": [],
  "lanes": [],
  "recordType": "COMPANY",
  "viewType": "board",
  "isPublic": true,
  "project": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {}
  },
  "users": [
    "string"
  ],
  "_id": "string"
}
```