List Properties

GET https://app.alaaqat.com/api/contacts/properties/

For more information about properties, check the Properties.

Parameters

This endpoint inherit Pagination parameters.

Key Type default Description
search string - Search by name
order string created_at Ordering the results

Response

The return type will always be Pagination<Property> check Pagination for more details.

{
    "data": [
        {
            "_id": "664e3fdfa14520a8d702e852",
            "type": "string",
            "name": {
                "ar": "Test"
            },
            "internal_name": "Test",
            "desc": {
                "ar": null
            },
            "group_id": "64f62b4b24ec98cbd50a8742",
            "account_id": 1,
            "made_by": 8,
            "updated_at": "2024-05-22T18:56:31.894000Z",
            "created_at": "2024-05-22T18:56:31.894000Z",
            "user": {
                "id": 8,
                "email": "ammar.alhasanat@alaaqat.com",
                "email_verified_at": "2023-10-23T14:18:27.000000Z",
                "created_at": "2023-10-23T13:37:08.000000Z",
                "updated_at": "2024-05-23T11:41:03.000000Z",
                "firstname": "Ammar",
                "lastname": "Alhasanat",
                "image": "https://alaaqat-public.s3.eu-west-1.amazonaws.com/users/8/FM3SACrjCXrx8UgXwAIGe1x8Ucb0ZClS1ZAAlbv2.jpg",
                "google_id": null,
                "google_token": null,
                "contacts_view_id": null,
                "two_factor_secret": null,
                "two_factor_recovery_codes": null,
                "two_factor_confirmed_at": null,
                "change_email_to": null,
                "locale": "en",
                "deals_view_id": null,
                "fullname": "Ammar Alhasanat"
            },
            "group": {
                "_id": "64f62b4b24ec98cbd50a8742",
                "internal_name": "contact_information",
                "name": {
                    "en": "Contact's Information",
                    "ar": "ملعومات العميل"
                },
                "desc": [],
                "account_id": null,
                "made_by": null,
                "updated_at": "2023-09-04T19:08:59.650000Z",
                "created_at": "2023-09-04T19:08:59.650000Z"
            }
        },
        {
            "_id": "64d5b87d68109f25280ebd12",
            "internal_name": "_id",
            "name": {
                "en": "ID",
                "ar": "الرقم المُعرف"
            },
            "desc": {
                "en": "Identification number set by Alaaqat and cannot be modified.",
                "ar": "رقم التعريف المحدد من قبل العلاقات ولا يمكن تعديله."
            },
            "type": "string",
            "system_only": true,
            "group_id": "64f62b4b24ec98cbd50a8742",
            "user": null,
            "group": {
                "_id": "64f62b4b24ec98cbd50a8742",
                "internal_name": "contact_information",
                "name": {
                    "en": "Contact's Information",
                    "ar": "ملعومات العميل"
                },
                "desc": [],
                "account_id": null,
                "made_by": null,
                "updated_at": "2023-09-04T19:08:59.650000Z",
                "created_at": "2023-09-04T19:08:59.650000Z"
            }
        },
        {
            "_id": "64d5b87d68109f25280ebd13",
            "internal_name": "firstname",
            "name": {
                "en": "Firstname",
                "ar": "الاسم الأول"
            },
            "desc": {
                "en": "",
                "ar": ""
            },
            "type": "string",
            "group_id": "64f62b4b24ec98cbd50a8742",
            "user": null,
            "group": {
                "_id": "64f62b4b24ec98cbd50a8742",
                "internal_name": "contact_information",
                "name": {
                    "en": "Contact's Information",
                    "ar": "ملعومات العميل"
                },
                "desc": [],
                "account_id": null,
                "made_by": null,
                "updated_at": "2023-09-04T19:08:59.650000Z",
                "created_at": "2023-09-04T19:08:59.650000Z"
            }
        },
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=4",
        "prev": null,
        "next": "/?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 4,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "/?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "/?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "/?page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "/?page=2",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 15,
        "to": 15,
        "total": 60
    }
}