GET https://app.alaaqat.com/api/companies/properties/groups
Lists the groups your company properties are organised in: the built-in groups and the ones you created. Your API key needs the company-property-group-index ability, and the team member who created the key needs View Field Groups.
{
"Accept": "application/json"
}
This endpoint accepts the Pagination parameters.
| Key | Type | Default | Description |
|---|---|---|---|
| search | string | - | Search by name or description. |
200 OK, or 206 Partial Content when more pages follow. A built-in group has account_id and user set to null.
{
"data": [
{
"_id": "6653c0d1e2f3a4b5c6d7e821",
"internal_name": "company_information",
"name": {
"en": "Company Information",
"ar": "معلومات الشركة"
},
"desc": [],
"account_id": null,
"made_by": null,
"updated_at": "2026-01-10T00:00:00.000000Z",
"created_at": "2026-01-10T00:00:00.000000Z",
"user": null
},
{
"_id": "6654e0f1a2b3c4d5e6f7a901",
"internal_name": "key_account_details",
"name": {
"en": "Key account details",
"ar": "تفاصيل الحسابات الرئيسية"
},
"desc": {
"en": "Extra details we keep on our largest companies",
"ar": "تفاصيل إضافية نحفظها عن أكبر شركات"
},
"account_id": 1024,
"made_by": 12,
"updated_at": "2026-10-19T14:00:00.000000Z",
"created_at": "2026-10-19T14:00:00.000000Z",
"user": {
"id": 12,
"email": "sara.haddad@example.com",
"firstname": "Sara",
"lastname": "Haddad",
"image": null,
"locale": "en",
"created_at": "2026-03-02T08:00:00.000000Z",
"updated_at": "2026-10-01T07:30:00.000000Z",
"fullname": "Sara Haddad"
}
}
],
"links": {
"first": "https://app.alaaqat.com/api/companies/properties/groups?page=1",
"last": "https://app.alaaqat.com/api/companies/properties/groups?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://app.alaaqat.com/api/companies/properties/groups?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://app.alaaqat.com/api/companies/properties/groups",
"per_page": 15,
"to": 2,
"total": 2
}
}