مستندات وب‌سرویس سرآور
ورود به داشبورد

مرجع api / leads/categories/

فهرست دسته‌بندی‌ها برای یک فیلد

برای فیلدهایی با field_type=category (مثل صنعت، جنسیت، شهر) لیست مقادیر مجاز را برمی‌گرداند تا در رابط کاربری به صورت dropdown نمایش دهید.

GETleads/categories/?type=<field_key>

برای فیلدهایی که در پاسخ leads/fields/ field_type برابر "category" دارند (مانند صنعت، جنسیت، شهر محل سکونت)، فهرست مقادیر مجاز را برمی‌گرداند. از این مقادیر در رابط کاربری dropdown یا multi-select استفاده می‌شود و برای فیلتر در leads/get-count/ و leads/get-records/ ضروری‌اند.

رایگان20 درخواست در دقیقه

هدرها

X-API-KEYstringبله

کلید api شما.

پارامترهای کوئری

typestringبله

کلید فیلد دسته‌بندی (مثل "gender"، "field_of_work_category"، "city_of_residence"). از مقادیر key در پاسخ leads/fields/ بگیرید.

نمونه درخواست

curl -X GET 'https://saravar.com/api/leads/categories/?type=field_of_work_category' \
  -H 'X-API-KEY: <YOUR_API_KEY>'

پاسخ

idintegerبله

شناسه دسته، در فیلتر استفاده می‌شود.

titlestringبله

نام نمایشی دسته (فارسی).

parent_idinteger | null

برای دسته‌بندی‌های سلسله‌مراتبی، شناسه دسته والد. اگر null باشد، دسته ریشه است.

full_titlestringبله

مسیر کامل دسته از ریشه (مثل "خدمات / فناوری اطلاعات / توسعه نرم‌افزار"). مناسب برای نمایش در نتایج جستجو.

خطاها

400کد وضعیت
علتپارامتر type ارسال نشده یا نام فیلد نامعتبر است.
اقدام پیشنهادیپارامتر type را با key یکی از فیلدهای پاسخ leads/fields/ مقداردهی کنید.
401کد وضعیت
علتهدر X-API-KEY مفقود است یا کلید نامعتبر است.
اقدام پیشنهادیکلید فعال در داشبورد بسازید.
429کد وضعیت
علتاز سقف نرخ کلید عبور کرده‌اید.
اقدام پیشنهادیتا انقضای Retry-After صبر کنید.