רשומות
חיפוש רשומות
POST
/api/v1/webhookחיפוש רשומות לפי שדה וערך ספציפי. מחזיר עד 50 תוצאות. שימושי למציאת רשומה לפי אימייל, טלפון או כל שדה אחר.
אימות
Authorizationstringheaderחובהכותרת אימות מסוג Bearer <token>, כאשר <token> הוא מפתח ה-API שלך.
פרמטרים
entitystringחובההslug של הישות
fieldstringחובהשם השדה לחיפוש
valuestringחובההערך לחיפוש
תשובה
200 — application/json
successbooleanחובהמציין אם הבקשה הצליחה
dataobjectאובייקט המכיל את נתוני התשובה
חיפוש רשומות
const response = await fetch('https://crm.heybase.co.il/api/v1/webhook', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"action": "search",
"entity": "contacts",
"field": "email",
"value": "israel@example.com"
}),
})
const data = await response.json()200
{
"success": true,
"count": 1,
"records": [
{
"id": "rec_abc123def456",
"data": {
"full_name": "ישראל ישראלי",
"email": "israel@example.com",
"phone": "050-1234567",
"status": "פעיל"
},
"createdAt": "2024-03-15T10: 30: 00.000Z",
"updatedAt": "2024-03-20T14: 15: 00.000Z"
}
]
}בעמוד זה
