{
  "info": {
    "name": "Saravar — Leads API",
    "description": "Saravar leads API · مجموعه endpoint های سرنخ سرآور. Set the `api_key` collection variable before sending. `base_url` is preconfigured. سه endpoint اول رایگان‌اند؛ get-records تنها endpoint پولی است و حذف خودکار تکرار دارد.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "_postman_id": "saravar-leads-collection"
  },
  "auth": {
    "type": "apikey",
    "apikey": [
      { "key": "key", "value": "X-API-KEY", "type": "string" },
      { "key": "value", "value": "{{api_key}}", "type": "string" },
      { "key": "in", "value": "header", "type": "string" }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://www.saravar.com/api",
      "description": "Saravar base URL (production)."
    },
    { "key": "api_key", "value": "", "description": "Your X-API-KEY value." }
  ],
  "item": [
    {
      "name": "Schema",
      "item": [
        {
          "name": "GET leads/fields/",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/leads/fields/",
              "host": ["{{base_url}}"],
              "path": ["leads", "fields", ""]
            },
            "description": "فهرست تمام فیلدهای قابل فیلتر. رایگان. معمولاً ابتدای جریان کاری برای ساخت رابط فیلتر."
          },
          "response": [
            {
              "name": "Success 200",
              "originalRequest": {
                "method": "GET",
                "header": [],
                "url": "{{base_url}}/leads/fields/"
              },
              "status": "OK",
              "code": 200,
              "header": [{ "key": "Content-Type", "value": "application/json" }],
              "body": "[{\"key\":\"city_of_residence\",\"field_type\":\"category\",\"description\":\"شهر محل سکونت\",\"supported_operands\":[\"equals\",\"in\"]},{\"key\":\"gender\",\"field_type\":\"category\",\"description\":\"جنسیت\",\"supported_operands\":[\"equals\"]}]"
            }
          ]
        },
        {
          "name": "GET leads/categories/",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/leads/categories/?type=field_of_work_category",
              "host": ["{{base_url}}"],
              "path": ["leads", "categories", ""],
              "query": [
                {
                  "key": "type",
                  "value": "field_of_work_category",
                  "description": "کلید فیلد دسته‌بندی (از پاسخ leads/fields/)."
                }
              ]
            },
            "description": "مقادیر مجاز برای فیلدهای دسته‌بندی. رایگان."
          },
          "response": [
            {
              "name": "Success 200",
              "originalRequest": {
                "method": "GET",
                "header": [],
                "url": "{{base_url}}/leads/categories/?type=field_of_work_category"
              },
              "status": "OK",
              "code": 200,
              "header": [{ "key": "Content-Type", "value": "application/json" }],
              "body": "[{\"id\":1,\"title\":\"فناوری اطلاعات\",\"parent_id\":null,\"full_title\":\"فناوری اطلاعات\"},{\"id\":2,\"title\":\"توسعه نرم‌افزار\",\"parent_id\":1,\"full_title\":\"فناوری اطلاعات / توسعه نرم‌افزار\"}]"
            }
          ]
        }
      ]
    },
    {
      "name": "Counting",
      "item": [
        {
          "name": "POST leads/get-count/",
          "request": {
            "method": "POST",
            "header": [{ "key": "Content-Type", "value": "application/json" }],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"filters\": [\n    { \"key\": \"city_of_residence\", \"operand\": \"in\", \"value\": [1, 5, 12] },\n    { \"key\": \"gender\", \"operand\": \"equals\", \"value\": 2 }\n  ]\n}",
              "options": { "raw": { "language": "json" } }
            },
            "url": {
              "raw": "{{base_url}}/leads/get-count/",
              "host": ["{{base_url}}"],
              "path": ["leads", "get-count", ""]
            },
            "description": "شمارش سرنخ‌های مطابق با فیلتر. رایگان."
          },
          "response": [
            {
              "name": "Success 200",
              "status": "OK",
              "code": 200,
              "header": [{ "key": "Content-Type", "value": "application/json" }],
              "body": "{\"count\":1842}"
            }
          ]
        }
      ]
    },
    {
      "name": "Records",
      "item": [
        {
          "name": "POST leads/get-records/",
          "request": {
            "method": "POST",
            "header": [{ "key": "Content-Type", "value": "application/json" }],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"filters\": [\n    { \"key\": \"city_of_residence\", \"operand\": \"in\", \"value\": [1, 5] },\n    { \"key\": \"gender\", \"operand\": \"equals\", \"value\": 2 }\n  ],\n  \"requested_fields\": [\"phone\"],\n  \"idempotency_key\": \"{{$guid}}\",\n  \"page\": 1,\n  \"limit\": 50\n}",
              "options": { "raw": { "language": "json" } }
            },
            "url": {
              "raw": "{{base_url}}/leads/get-records/",
              "host": ["{{base_url}}"],
              "path": ["leads", "get-records", ""]
            },
            "description": "دریافت سرنخ‌های پولی با حذف خودکار تکرار. هزینه از کیف‌پول دارنده کلید کسر می‌شود. ترکیبات قبلاً خریداری‌شده رایگان برمی‌گردند."
          },
          "response": [
            {
              "name": "Success 200",
              "status": "OK",
              "code": 200,
              "header": [{ "key": "Content-Type", "value": "application/json" }],
              "body": "{\"count\":120,\"previous\":false,\"next\":true,\"debit_transaction_id\":90142,\"total_charged\":\"50000\",\"results\":[{\"lead_id\":9001,\"lead_type\":\"phonenumber\",\"lead_data\":\"+98912XXXXXXX\",\"phone\":\"+98912XXXXXXX\"}]}"
            }
          ]
        }
      ]
    }
  ]
}