---
title: "Pipelines.list"
method: GET
path: "/entities/Pipelines"
tags: ["Pipeline"]
---

# Pipelines.list

`GET /entities/Pipelines`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Pipelines`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/Pipelines/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a page of Pipeline records, optionally filtered, sorted and limited to selected fields.

## Query parameters

- `include-deleted` boolean
- `first` integer
- `last` integer
- `before` string
- `after` string
- `expand` string
- `order-by` string
- `filter` object
- `filter-op` object
- `load-only` string

## Response `200`

Page of Pipeline records.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` Pipeline[]
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `id` string, uuid, required: Unique identifier of entity.
    - `is_deleted` boolean: Specifies if the entity is considered deleted.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `color` integer, required: Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue.
    - `name` string, required: Name of the entity and its default text representation.
    - `revision` integer: Revision when entity was lastly changed.
    - `steps` BatchStepInput[], required: Steps that make up this pipeline, in the order opportunities move through them.
      - `description` string: Free-text description shown in the step UI.
      - `has_readonly_form` boolean: When true, the record form is read-only while a record is in this step.
      - `has_version_increment` boolean: When true, transitioning a record into this step bumps its version counter.
      - `lead_process_id` string, uuid: Id of the lead process this step belongs to, or empty when the step is not part of a lead process.
      - `name` string: Name of the entity and its default text representation.
      - `percent` integer: Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
      - `quote_process_id` string, uuid: Id of the quote process this step belongs to, or empty when the step is not part of a quote process.
      - `sort_order` integer: Position of the step within its pipeline or process; lower values appear first.
      - `timeframe` integer: Expected number of days a record should spend in this step. Used to flag overdue records.
      - `revision` integer: Revision when entity was lastly changed.
      - `documents` object[]: Files attached to the step (e.g. step-specific documentation or templates).
        - `id` string, uuid: Id of the related CloudObjectStepRelation record.
      - `step_checklists` object[]: Checklist items the user must complete before moving a record out of this step.
        - `id` string, uuid: Id of the related StepChecklist record.
      - `id` string, uuid: ID of object to update.
    - `opportunity_types` string[], required: Opportunity types that follow this pipeline.
  - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used.
    - `start_cursor` string: Cursor of the first record of the page.
    - `end_cursor` string: Cursor of the last record of the page.
    - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them.
    - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them.
  - `total` integer: Number of records that match the request, across all pages.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)