Search Person

جستجوی شخص

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

POST https://app.didar.me/api/contact/PersonSearch?apikey={{API_KEY}}

پارامترهای Query

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

Header درخواست

Content-Type: application/json

بدنه درخواست

Criteria · object · required

مجموعه معیارهای جست‌وجو و فیلتر؛ فقط رکوردهایی که با این شرایط سازگار باشند در نتیجه برگردانده می‌شوند.

Show property

Criteria.IsDeleted · number

مشخص می‌کند رکورد حذف شده است یا همچنان فعال است. مقادیری که می توانید ارسال کنید: 0 → رکورد حذف نشده باشد 1 → حذف شده باشد

Criteria.IsPinned · number

فیلتر سنجاق‌شدن رکوردها. مقادیری که می توانید ارسال کنید: -1 → سنجاق نشده باشد 1 → سنجاق شده باشد

Criteria.IsVIP · number

فیلتر مخاطبان ویژه. مقادیری که می توانید ارسال کنید: -1 → شخص ویژه نباشد 1 → شخص ویژه باشد

Criteria.SortOrder · number

جهت مرتب‌سازی نتایج، مانند صعودی یا نزولی.

Criteria.Keywords · null

عبارتی است که جست‌وجو براساس آن انجام می‌شود. نتیجه فقط رکوردهایی را برمی‌گرداند که فیلد متنی مرتبط با این عبارت تطبیق داشته باشد.

Criteria.MobilePhone · string

شماره موبایل برای جست‌وجو یا محدودکردن نتایج مخاطبان.

Criteria.WorkPhone · string

شماره تلفن محل کار برای جست‌وجوی مخاطب.

Criteria.Email · string

نشانی ایمیل برای جست‌وجوی مخاطب.

Criteria.NationalCode · string

کد ملی برای جست‌وجوی شخص.

Criteria.ZipCode · string

کد پستی برای محدودکردن نتایج مخاطبان.

Criteria.CustomerCode · string

کد مشتری برای جست‌وجوی دقیق مخاطب.

Criteria.SearchFromTime · string

ابتدای بازه زمانی جست‌وجو؛ رکوردهای پیش از این زمان از نتیجه حذف می‌شوند.

Criteria.SearchToTime · string

انتهای بازه زمانی جست‌وجو؛ رکوردهای پس از این زمان از نتیجه حذف می‌شوند.

From · number

اندیس شروع نتایج برای صفحه‌بندی است. مثلا 0 یعنی دریافت از اولین نتیجه و 20 یعنی ۲۰ نتیجه اول رد شوند.

Limit · number

حداکثر تعداد رکوردی است که در همین پاسخ برگردانده می‌شود.

Request Body (JSON)

{
    "Criteria": {
        "IsDeleted": 0,
        "IsPinned": -1,
        "IsVIP": -1,
        "SortOrder": 1,
        "Keywords": "test",
        "MobilePhone": "09108907328",
        "WorkPhone": "",
        "Email": "",
        "NationalCode": "",
        "ZipCode": "",
        "CustomerCode": "",
        "SearchFromTime": "1000-01-01T08:59:22Z",
        "SearchToTime": "9999-12-29T08:59:22Z",
        "CustomFields": [
           { 
            "Field_996_0_226" : "test" 
           } 
        ]
    },
    "From": 0,
    "Limit": 2
}

Request Response (JSON)

{
    "Response": {
        "TotalCount": 24,
        "List": [
            {
                "Id": "c15ab449-4432-4ebc-9b96-d39db57af988",
                "Code": 14503,
                "Title": "جناب آقای",
                "FirstName": "12",
                "LastName": "آشنasasا",
                "DisplayName": "12 آشنasasا",
                "MobilePhone": "09391232",
                "CompanyName": "",
                "WorkPhone": "02155587458",
                "WorkPhoneExtension": "تلفن منشی",
                "CompanyIsCustomer": false,
                "CompanyIsProspect": false,
                "Position": "مدیر واحد",
                "RegisterTime": "2026-07-28T09:03:58Z",
                "IsVIP": true,
                "BackgroundInfo": "12312sdsd",
                "Type": "Person",
                "LeadType": "General",
                "ContactType": "General",
                "IsDeleted": false,
                "CanDelete": true,
                "CanEdit": true,
                "IsMine": false,
                "HasAccess": true,
                "LeadGenerationType": "Manual",
                "HasCompany": true,
                "CompanyId": "39e05281-f35a-4923-bed4-8d2db9947be8",
                "Email": "",
                "Feedback": 60.0,
                "VisibilityType": "All",
                "Owner": {
                    "UserId": "f1599895-3d58-44a8-a830-e77b42d8e4c6",
                    "DisplayName": " محمد علی مزینی",
                    "PictureUrl": "/PortalData/Subsystems/Profile/UserPics/52c406aa-ae3d-4699-b253-6c5af7648549.jpg",
                    "Email": "[e-mail]"
                },
                "OwnerId": "f1599895-3d58-44a8-a830-e77b42d8e4c6",
                "ContactStatus": {},
                "Segments": [],
                "_Type": null,
                "KeepInTouch": null,
                "Fields": {
                    "Field_996_0_7": "asdfasdfasdf",
                    "Field_996_0_8": "asdfasdfasdf"
                },
                "LastUpdateTime": "2026-07-28T09:03:58Z",
                "OwnerId_Old": "f1599895-3d58-44a8-a830-e77b42d8e4c6",
                "CustomerCode": "12311213",
                "NationalCode": "asdfdsdd2132",
                "ZipCode": "123assdddf",
                "NationalID": "",
                "RegistrationNumber": "",
                "EconomicIssue": ""
            },
            {
                "Id": "1fa676b1-7319-4d08-84c1-7ac6010d0c4f",
                "Code": 14260,
                "Title": "",
                "FirstName": "",
                "LastName": "تست ایجاد دستی",
                "DisplayName": "تست ایجاد دستی",
                "MobilePhone": "",
                "CompanyName": "",
                "WorkPhone": "",
                "WorkPhoneExtension": "",
                "CompanyIsCustomer": null,
                "CompanyIsProspect": null,
                "Position": "",
                "RegisterTime": "2026-04-22T07:10:11Z",
                "IsVIP": true,
                "BackgroundInfo": "",
                "Type": "Person",
                "LeadType": "General",
                "ContactType": "Prospect",
                "IsDeleted": false,
                "CanDelete": true,
                "CanEdit": true,
                "IsMine": false,
                "HasAccess": true,
                "LeadGenerationType": "Manual",
                "HasCompany": false,
                "CompanyId": "00000000-0000-0000-0000-000000000000",
                "Email": "",
                "Feedback": 60.0,
                "VisibilityType": "Owner",
                "Owner": {
                    "UserId": "c668fb14-52e6-4b5b-869d-8603e060abf5",
                    "DisplayName": "عارفه کامیاب",
                    "PictureUrl": "/PortalData/Subsystems/Profile/UserPics/ed7950b0-6012-4a11-9156-efd2c4fb02df.jpg",
                    "Email": "[e-mail]"
                },
                "OwnerId": "c668fb14-52e6-4b5b-869d-8603e060abf5",
                "ContactStatus": {},
                "Segments": [],
                "_Type": null,
                "KeepInTouch": null,
                "Fields": {},
                "LastUpdateTime": "2026-06-13T12:32:29Z",
                "OwnerId_Old": "c668fb14-52e6-4b5b-869d-8603e060abf5",
                "CustomerCode": "",
                "NationalCode": "",
                "ZipCode": "",
                "NationalID": "",
                "RegistrationNumber": "",
                "EconomicIssue": ""
            }
        ]
    }
}