> ## Documentation Index
> Fetch the complete documentation index at: https://didar-crm.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Deal Pipelines

# فهرست کاریز معاملات

هر معامله داخل یکی از مراحل کاریز فروش قرار می‌گیرد.‎ این Endpoint فهرست کاریزهای معامله و مراحل هرکدام را برمی‌گرداند تا ID کاریز و مرحله موردنظر را برای ایجاد، ویرایش یا جستجوی معاملات استفاده کنید.‎

```http theme={null}
POST {{baseURL}}/api/pipeline/list/0?apikey={{API_KEY}}
```

## پارامترهای Query

| پارامتر  | نوع      | وضعیت  | توضیح           |
| -------- | -------- | ------ | --------------- |
| `apikey` | `string` | الزامی | کلید API دیدار. |

## بدنه درخواست

> این درخواست بدنه ندارد.

## قواعد و محدودیت‌ها

* لیستی از پارامتر کاریز معاملات را میدهد
* مقدار `Response[].Id` برابر است با شناسه کاریز معامله
* مقدار `Response[].Stages[].Id` برابر است با شناسه مرحله یک کاریز مشخص معامله

<RequestExample>
  ```shellscript Request Body (cURL) theme={null}
  curl --location --request POST '{{baseURL}}/api/pipeline/list/0?apikey={{API_KEY}}'
  ```
</RequestExample>

<ResponseExample>
  ```json Request Response (JSON) highlight={4,9,20,31} theme={null}
  {
      "Response": [
          {
              "Id": "82063d6f-07b8-4e5b-82ac-b8bea5ed9a38",
              "Title": "کاریز تست",
              "Index": 1,
              "Stages": [
                  {
                      "Id": "1f98965b-d5fa-40e1-be80-b7fcba79e0cf",
                      "Title": "مذاکرات اولیه",
                      "Color": "#b88d7c",
                      "Index": 1,
                      "IdleDay": 0,
                      "Probability": 100,
                      "IdleIsActive": false,
                      "PortalTitle": "",
                      "Description": null
                  },
                  {
                      "Id": "5e623515-7948-4331-8497-bbe1b1ddd12b",
                      "Title": "پیگیری",
                      "Color": "#23b13a",
                      "Index": 2,
                      "IdleDay": 0,
                      "Probability": 100,
                      "IdleIsActive": false,
                      "PortalTitle": "",
                      "Description": null
                  },
                  {
                      "Id": "a5b02fa5-9cb6-49ca-96c9-15a3f0b8bfa0",
                      "Title": "قیمت و نهایی کردن",
                      "Color": "#5d5b55",
                      "Index": 3,
                      "IdleDay": 0,
                      "Probability": 100,
                      "IdleIsActive": false,
                      "PortalTitle": "",
                      "Description": null
                  }
              ],
              "Type": "Deal"
          }
      ]
  }
  ```
</ResponseExample>

## لینک های مرتبط

* [Create Deal](/untitled-page-23)
* [Update Deal](/untitled-page-25)
* [Search Deal](/untitled-page-27)