Get

[POST] .../v1/pipeline/get

Returns CRM pipelines with ACL restrictions applied. Use this method to list CRM pipelines for Lead or Deal workflows, stage selection and access-aware configuration screens. The response returns paged Pipeline records with next_offset and total, including entity type, default flag, ACL settings, active flag and active stages sorted by Lead system-stage order or by sort_order for other entity types. The request body is required and must select entity_type either through filters; ids, active, limit and offset further narrow the result. The caller must have CRM pipeline select permission and can see only pipelines allowed by ACL, unless the caller has CRM manage-all permission; missing entity_type, denied access, invalid filters, ACL lookup errors, database failures and persistent lookup errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Requested item count. Non-positive values use the default page size.
offset Int32 Optional Result set offset. If the value is less than 0, 0 is used.

Filterable Fields

Field Type Description
active bool Filter by active flag.
entity_type string Filter by entity type: Lead or Deal. This field is required unless it is supplied through filters.
id int Filter by pipeline IDs.

Request Example

{
  "filters": [
    {
      "Field": "entity_type",
      "Operator": "Equal",
      "Value": "Lead"
    },
    {
      "Field": "active",
      "Operator": "Equal",
      "Value": "true"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of Pipeline Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 7,
      "entity_type": "Lead",
      "name": "Lead pipeline",
      "is_default": true,
      "access_all": false,
      "access_user_ids": [
        1,
        15
      ],
      "access_group_ids": [
        4
      ],
      "active": true,
      "last_update": 1712345600,
      "stages": [
        {
          "id": 25,
          "pipeline_id": 7,
          "name": "New",
          "code": "new",
          "sort_order": 10,
          "is_start": true,
          "is_terminal": false,
          "is_success": false,
          "active": true,
          "last_update": 1712345600
        },
        {
          "id": 27,
          "pipeline_id": 7,
          "name": "Won",
          "code": "won",
          "sort_order": 90,
          "is_start": false,
          "is_terminal": true,
          "is_success": true,
          "active": true,
          "last_update": 1712345600
        },
        {
          "id": 28,
          "pipeline_id": 7,
          "name": "Lost",
          "code": "lost",
          "sort_order": 100,
          "is_start": false,
          "is_terminal": true,
          "is_success": false,
          "active": true,
          "last_update": 1712345600
        }
      ]
    }
  ],
  "next_offset": 0,
  "total": 1
}