List contacts of a category - HQ Rental Software

Returns the contacts of one category, newest first, as a page of Contact rows. Each row also has pivot, which links the contact to the category.

created_at and updated_at on these rows are shifted to your API user's time zone (see Dates, time zones and money) although they end in Z. updated_since compares against the stored UTC value.

Use filters for exact searches and global_search for a quick free-text search.

Responses

🟢200OK

application/json

A page of contacts. A successful body has no success field. HTTP 200 is also used for failures: such a body has success: false and is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "current_page": 1,
    "data": [
        {
            "id": 1532,
            "uuid": "c4f1a2b3-5d6e-4f70-8a91-b2c3d4e5f607",
            "label": "Jane Doe",
            "entity": "person",
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "jane.doe@example.com",
            "phone_number": 3055550100,
            "street": "120 Main St",
            "street2": "",
            "city": "Miami",
            "state": "FL",
            "zip": "33101",
            "country": "us",
            "external_contact_type": "crm",
            "external_contact_id": "A-1029",
            "verified": true,
            "language": "en",
            "f252": [],
            "created_by": 2,
            "updated_by": 2,
            "created_at": "2026-03-04T13:21:42.000000Z",
            "updated_at": "2026-03-04T13:21:42.000000Z",
            "deleted_at": null,
            "pivot": {
                "category_id": 3,
                "contact_id": 1532
            }
        }
    ],
    "first_page_url": "https://api.hqrentals.app/api/contacts/categories/3/contacts?page=1",
    "from": 1,
    "last_page": 3,
    "last_page_url": "https://api.hqrentals.app/api/contacts/categories/3/contacts?page=3",
    "links": [
        {
            "url": null,
            "label": "&laquo; Previous",
            "page": null,
            "active": false
        },
        {
            "url": "https://api.hqrentals.app/api/contacts/categories/3/contacts?page=1",
            "label": "1",
            "page": 1,
            "active": true
        },
        {
            "url": "https://api.hqrentals.app/api/contacts/categories/3/contacts?page=2",
            "label": "Next &raquo;",
            "page": 2,
            "active": false
        }
    ],
    "next_page_url": "https://api.hqrentals.app/api/contacts/categories/3/contacts?page=2",
    "path": "https://api.hqrentals.app/api/contacts/categories/3/contacts",
    "per_page": 10,
    "prev_page_url": null,
    "to": 10,
    "total": 24
}

🟠400Bad Request

🟠404Record Not Found