List Deals

GET https://app.alaaqat.com/api/deals

Parameters

This endpoint inherit Pagination parameters.

This endpoint has Complex Filtration feature.

Key Type default Description
search string - Search by deal_name
order string created_at Ordering the results
complex_filters array [] See Complex Filtration

Response

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

{
    "data": [
        {
            "properties": {
                "_id": "665529bdf8309b0cae098992",
                "deal_name": "test",
                "amount": 50,
                "deal_stage": "appointment_scheduled",
                "updated_at": "2024-05-28T00:47:57.670000Z",
                "created_at": "2024-05-28T00:47:57.670000Z"
            },
            "contacts": [
                {
                    "_id": "65cb6719ae87531d6c045873",
                    "account_id": 1,
                    "firstname": "Ammar",
                    "lastname": "Alhasanat",
                },
                {
                    "_id": "66036296905a0cb19b08bd75",
                    "account_id": 1,
                    "firstname": "Ammar",
                    "lastname": "Alhasanat",
                }
            ]
        },
        {
            "properties": {
                "_id": "66552c5bf8309b0cae098994",
                "deal_name": "test",
                "amount": 50,
                "deal_stage": "appointment_scheduled",
                "updated_at": "2024-05-28T00:59:07.325000Z",
                "created_at": "2024-05-28T00:59:07.325000Z"
            },
            "contacts": [
                {
                    "_id": "65cb6719ae87531d6c045873",
                    "account_id": 1,
                    "firstname": "Ammar",
                    "lastname": "Alhasanat",
                },
                {
                    "_id": "66036296905a0cb19b08bd75",
                    "account_id": 1,
                    "firstname": "Ammar",
                    "lastname": "Alhasanat",
                }
            ]
        }
    ],
    "links": {
        "first": "https://app.alaaqat.com/api/deals?page=1",
        "last": "https://app.alaaqat.com/api/deals?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://app.alaaqat.com/api/deals?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://app.alaaqat.com/api/deals",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}