List Contacts

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

Parameters

This endpoint inherit Pagination parameters.

This endpoint has Complex Filtration feature.

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

Response

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

{
    "data": [
        {
            "properties": {
                "_id": "6609aaa89ab0c41c340125d4",
                "account_id": 1,
                "firstname": "tjrbeh",
                "lastname": null,
                "email": "hello@email.com",
                "updated_at": "2024-03-31T18:25:44.187000Z",
                "created_at": "2024-03-31T18:25:44.148000Z",
                "fullname": "tjrbeh ",
                "image": "https://ui-avatars.com/api/?rounded=true&bold=true&name=tjrbeh &background=4B5563&color=fff",
                "account": {
                    "id": 1,
                    "name": "علاقات",
                    "created_at": null,
                    "updated_at": "2024-03-29T22:51:34.000000Z",
                    "industry": "any",
                    "logo": "/storage/accounts/1/logo/jCYIzoiXoRPxZh54ljyO5wFkCzzrNq6avHFeqnUX.png",
                    "address": null,
                    "timeZone": null,
                    "calendar": null,
                    "hour12": null,
                    "locale": null,
                    "currency": "USD"
                }
            },
            "channels": []
        }
    ],
    "links": {
        "first": "http://localhost/api/contacts?limit=1&page=1",
        "last": "http://localhost/api/contacts?limit=1&page=115",
        "prev": null,
        "next": "http://localhost/api/contacts?limit=1&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 115,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=7",
                "label": "7",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=8",
                "label": "8",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=9",
                "label": "9",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=10",
                "label": "10",
                "active": false
            },
            {
                "url": null,
                "label": "...",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=114",
                "label": "114",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=115",
                "label": "115",
                "active": false
            },
            {
                "url": "http://localhost/api/contacts?limit=1&page=2",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "http://localhost/api/contacts",
        "per_page": 1,
        "to": 1,
        "total": 115
    }
}