חברות

נקודות קצה לניהול חברות.

רשימת חברות get

שליפת רשימה עם עימוד.

https://your-company.example.com/api/companies

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרי שאילתה

פרמטר סוג תיאור
page אופציונלי integer מספר עמוד. ברירת מחדל: 1.
per_page אופציונלי integer גודל עמוד (עד 100 ברוב המשאבים). ברירת מחדל: 15.
q אופציונלי string מחרוזת חיפוש חופשית.
order אופציונלי string מיון. דוגמה: `created_at` או `created_at|desc`.
select אופציונלי string בחירת שדות. דוגמה: `id;first_name;email`.
with אופציונלי string טעינת יחסים (eager load).

שליפת חברה get

שליפת רשומה בודדת לפי מזהה.

https://your-company.example.com/api/companies/{company}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
company חובה integer מזהה הרשומה.

יצירת חברה post

יצירת רשומה חדשה. תשובה מוצלחת מחזירה סטטוס 201.

https://your-company.example.com/api/companies

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
name חובה string שם החברה.
domain אופציונלי string דומיין.
email אופציונלי string אימייל ייחודי.
phones אופציונלי array מערך `{number, type}`.
industry_id אופציונלי integer תעשייה.
source_id אופציונלי integer מקור.
user_id אופציונלי integer בעלים.
parent_company_id אופציונלי integer חברת אם.
street אופציונלי string רחוב.
city אופציונלי string עיר.
state אופציונלי string מחוז.
postal_code אופציונלי string מיקוד.
country_id אופציונלי integer מדינה.
contacts אופציונלי array מזהי אנשי קשר.
deals אופציונלי array מזהי עסקאות.
tags אופציונלי array תגיות.

דוגמת גוף בקשה

{
    "name": "אקמה בע\"מ",
    "domain": "acme.co.il",
    "email": "info@acme.co.il",
    "phones": [
        {
            "number": "+97239111222",
            "type": "work"
        }
    ],
    "industry_id": 1,
    "user_id": 1,
    "contacts": [
        1
    ]
}

עדכון חברה put

עדכון חלקי או מלא של רשומה קיימת.

https://your-company.example.com/api/companies/{company}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
company חובה integer מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
name אופציונלי string שם החברה.
domain אופציונלי string דומיין.
email אופציונלי string אימייל ייחודי.
phones אופציונלי array מערך `{number, type}`.
industry_id אופציונלי integer תעשייה.
source_id אופציונלי integer מקור.
user_id אופציונלי integer בעלים.
parent_company_id אופציונלי integer חברת אם.
street אופציונלי string רחוב.
city אופציונלי string עיר.
state אופציונלי string מחוז.
postal_code אופציונלי string מיקוד.
country_id אופציונלי integer מדינה.
contacts אופציונלי array מזהי אנשי קשר.
deals אופציונלי array מזהי עסקאות.
tags אופציונלי array תגיות.

מחיקת חברה delete

מחיקה רכה. תשובה מוצלחת: 204 No Content.

https://your-company.example.com/api/companies/{company}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
company חובה integer מזהה הרשומה.

צירוף שיוכים לחברה put

https://your-company.example.com/api/associations/companies/{company}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
company חובה integer מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
contacts אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
deals אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
activities אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
documents אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.

דוגמת גוף בקשה

{
    "contacts": [
        1
    ],
    "deals": [
        2
    ],
    "activities": [
        3
    ],
    "documents": [
        4
    ]
}
יש לספק לפחות משאב אחד בגוף הבקשה.

ניתוק שיוכים מחברה delete

https://your-company.example.com/api/associations/companies/{company}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
company חובה integer מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
contacts אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
deals אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
activities אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
documents אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
יש לספק לפחות משאב אחד בגוף הבקשה.

סנכרון שיוכים לחברה post

https://your-company.example.com/api/associations/companies/{company}

כותרות חובה

פרמטר סוג תיאור
Accept חובה string `application/json`
Content-Type חובה string `application/json` (בבקשות עם גוף)
Authorization חובה string `Bearer {token}`

פרמטרים בנתיב

פרמטר סוג תיאור
company חובה integer מזהה הרשומה.

פרמטרים בגוף הבקשה

פרמטר סוג תיאור
contacts אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
deals אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
activities אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
documents אופציונלי array מערך מזהים לשיוך. יש לספק לפחות משאב אחד.
סנכרון מלא: מערך ריק למשאב מנתק את כל השיוכים של אותו סוג.

© 2026 BeCRM