GET https://app.alaaqat.com/api/companies
تعرض هذه النقطة الشركات في حسابك، الأحدث أولاً. يحتاج مفتاح واجهة التطبيق البرمجية إلى الإمكانية company-index.
تضم القائمة الشركات التي يراها في التطبيق عضو الفريق الذي أنشأ المفتاح: جميعها مع صلاحية عرض جميع الشركات، أو تلك التي يملكها هو أو فرقه فقط مع صلاحية عرض الشركات الخاصة بالفريق أو عرض الشركات الخاصة بالمستخدم.
{
"Accept": "application/json"
}
تقبل هذه النقطة معطيات الصفحات بحد أقصى 250 سجلاً في الصفحة، وتدعم التصفية المعقدة.
| المفتاح | النوع | الافتراضي | الوصف |
|---|---|---|---|
| search | نص | - | البحث حسب الاسم. |
| complex_filters | مصفوفة | [] | التصفية حسب قيم الخصائص. راجع التصفية المعقدة. |
| forAssociationType | نص | - | مع forAssociationId، تعرض فقط الشركات المرتبطة بسجل واحد. راجع الارتباطات. |
| forAssociationId | نص | - | قيمة _id للسجل الذي تريد الشركات المرتبطة به. |
200 OK، أو 206 Partial Content إذا تبقّت صفحات أخرى. تأتي الشركات ضمن data، وقيم خصائص كل سجل ضمن properties. راجع الصفحات لمعنى links وmeta.
{
"data": [
{
"properties": {
"_id": "6655a1b2c3d4e5f6a7b8c901",
"name": "Blue Harbor Trading",
"website_url": "https://blueharbor.example.com",
"industry": "Wholesale",
"city": "Amman",
"country_region": "Jordan",
"phone": "96265000000",
"num_employees": 45,
"lifecycle_stage": "customer",
"owner": 12,
"created_by": 12,
"updated_at": "2026-10-20T09:30:00.000000Z",
"created_at": "2026-10-20T09:30:00.000000Z"
},
"account_id": 1024
},
{
"properties": {
"_id": "6655a1b2c3d4e5f6a7b8c902",
"name": "Cedar Valley Clinics",
"website_url": "https://cedarvalley.example.com",
"industry": "Healthcare",
"city": "Irbid",
"country_region": "Jordan",
"phone": "96227000000",
"num_employees": 120,
"lifecycle_stage": "lead",
"owner": 12,
"created_by": 12,
"updated_at": "2026-10-18T11:00:00.000000Z",
"created_at": "2026-10-18T11:00:00.000000Z"
},
"account_id": 1024
}
],
"links": {
"first": "https://app.alaaqat.com/api/companies?page=1",
"last": "https://app.alaaqat.com/api/companies?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?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://app.alaaqat.com/api/companies",
"per_page": 15,
"to": 2,
"total": 2
}
}