{"openapi":"3.1.0","info":{"title":"Realton REST API","version":"1.0.0","description":"An agency's catalog and CRM in Realton, for its own systems: projects in five markets with their prices and payment plans, clients, notes, tasks, a deal's stage and brochure links. Every call acts as the member who made the key, with what that member can see in Realton. Nothing here sends anything to a client.","x-he":"הקטלוג וה-CRM של הסוכנות ב-Realton, למערכות שלה: פרויקטים בחמישה שווקים עם המחירים ותוכניות התשלום, לקוחות, הערות, משימות, השלב של עסקה וקישורים לברושורים. כל קריאה פועלת בשם מי שיצר את המפתח, עם מה שהוא רואה ב-Realton. שום דבר כאן לא שולח משהו ללקוח."},"servers":[{"url":"https://realton.ai/api/v1"}],"security":[{"realtonKey":[]}],"tags":[{"name":"catalog","description":"The catalog: projects and their details.","x-he":"הקטלוג: פרויקטים והפרטים שלהם."},{"name":"clients","description":"The member's clients, their cards and notes.","x-he":"הלקוחות, הכרטיסים וההערות."},{"name":"tasks","description":"Tasks, with or without a date.","x-he":"משימות, עם תאריך או בלי."},{"name":"deals","description":"A deal's stage in the pipeline.","x-he":"השלב של עסקה בצינור."},{"name":"brochures","description":"Branded, tracked brochure links for the agent to send.","x-he":"קישורים לברושורים במותג שלכם, עם מעקב, לשליחה על ידי הסוכן."}],"paths":{"/projects":{"get":{"operationId":"listProjects","tags":["catalog"],"summary":"Search the catalog","x-summary-he":"חיפוש בקטלוג","description":"Projects that fit, newest first, with their price from. Up to 100 a page.","x-he":"פרויקטים מתאימים, החדשים קודם, עם המחיר ההתחלתי. עד 100 בעמוד.","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":120},"description":"Words of a project's or a developer's name.","x-he":"מילים משם הפרויקט או היזם."},{"name":"place","in":"query","required":false,"schema":{"type":"string","maxLength":80},"description":"A city or an emirate, by name or slug: Dubai, Batumi, Limassol.","x-he":"עיר או אמירות, בשם או ב-slug: Dubai,‏ Batumi,‏ Limassol."},{"name":"area","in":"query","required":false,"schema":{"type":"string","maxLength":80},"description":"An area, by name or slug: Dubai Islands, JVC.","x-he":"אזור, בשם או ב-slug: Dubai Islands,‏ JVC."},{"name":"beds","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":9},"description":"Bedrooms: 0 is a studio, 4 is four and more.","x-he":"חדרי שינה: 0 הוא סטודיו, 4 הוא ארבעה ומעלה."},{"name":"maxPrice","in":"query","required":false,"schema":{"type":"number","minimum":0},"description":"The most the client would pay, in `currency`.","x-he":"הסכום הגבוה ביותר שהלקוח ישלם, ב-`currency`."},{"name":"currency","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Z]{3}$","default":"AED"},"description":"The currency of `maxPrice`.","x-he":"המטבע של `maxPrice`."},{"name":"handoverBy","in":"query","required":false,"schema":{"type":"integer","minimum":2025,"maximum":2045},"description":"The latest handover year.","x-he":"שנת המסירה המאוחרת ביותר."},{"name":"lang","in":"query","required":false,"schema":{"type":"string","enum":["en","he"],"default":"en"},"description":"The language of place and area names.","x-he":"השפה של שמות המקומות והאזורים."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"description":"How many projects in this page.","x-he":"כמה פרויקטים בעמוד הזה."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0},"description":"How many to skip: the next page starts at offset + limit.","x-he":"כמה לדלג: העמוד הבא מתחיל ב-offset + limit."}],"responses":{"200":{"description":"The projects that fit, and how many there are in all.","x-he":"הפרויקטים המתאימים, וכמה יש בסך הכול.","content":{"application/json":{"schema":{"type":"object","required":["total","offset","catalogDate","projects"],"properties":{"total":{"type":"integer","description":"How many projects fit, across all pages.","x-he":"כמה פרויקטים מתאימים בכל העמודים."},"offset":{"type":"integer","description":"The offset of this page.","x-he":"ה-offset של העמוד הזה."},"catalogDate":{"type":"string","description":"The day the catalog was last built, YYYY-MM-DD.","x-he":"היום שבו הקטלוג נבנה לאחרונה, YYYY-MM-DD."},"projects":{"type":"array","items":{"$ref":"#/components/schemas/ProjectSummary"}}}},"example":{"total":312,"offset":0,"catalogDate":"2026-10-24","projects":[{"key":"studio:soma-residences","name":"Soma Residences","developer":"Origami Properties","market":"ae","place":"Dubai","area":"Dubai Islands","stage":"OFF_PLAN","handover":"Q4 2028","priceFrom":1670000,"currency":"AED","bedrooms":[1,2,3],"commissionPct":5,"photo":"https://…/soma-residences.avif"}]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"}}}},"/projects/{key}":{"get":{"operationId":"getProject","tags":["catalog"],"summary":"One project in full","x-summary-he":"פרויקט אחד במלואו","description":"Unit types with sizes and prices, payment plans, amenities, the gallery and what is nearby.","x-he":"סוגי יחידות עם שטחים ומחירים, תוכניות תשלום, מתקנים, הגלריה ומה יש בסביבה.","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","pattern":"^(studio|wp|snap):[A-Za-z0-9_.:-]{1,120}$"},"description":"The project key from `GET /projects`.","x-he":"מפתח הפרויקט מ-`GET /projects`."},{"name":"lang","in":"query","required":false,"schema":{"type":"string","enum":["en","he"],"default":"en"},"description":"The language of names, plans and amenities.","x-he":"השפה של השמות, תוכניות התשלום והמתקנים."}],"responses":{"200":{"description":"The project.","x-he":"הפרויקט.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDetail"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/clients":{"get":{"operationId":"listClients","tags":["clients"],"summary":"Your clients","x-summary-he":"הלקוחות שלכם","description":"An agent's own clients; an owner's or an admin's, the agency's. Last active first.","x-he":"סוכן מקבל את הלקוחות שלו, ובעלים או מנהל את כל לקוחות הסוכנות. הפעילים לאחרונה קודם.","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":80},"description":"A name, a number or an email to look for.","x-he":"שם, מספר או מייל לחיפוש."}],"responses":{"200":{"description":"The clients.","x-he":"הלקוחות.","content":{"application/json":{"schema":{"type":"object","required":["clients"],"properties":{"clients":{"type":"array","items":{"$ref":"#/components/schemas/ClientRow"}}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"}}},"post":{"operationId":"createClient","tags":["clients"],"summary":"A new client","x-summary-he":"לקוח חדש","description":"A name and at least one way to reach them is the usual; a name alone is accepted.","x-he":"בדרך כלל שם ולפחות דרך אחת ליצור קשר; גם שם לבד מתקבל.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Their full name.","x-he":"השם המלא.","minLength":1,"maxLength":120},"whatsapp":{"type":"string","description":"A number with its country code, +971 50 555 0147.","x-he":"מספר עם קידומת מדינה, ‎+971 50 555 0147.","maxLength":30},"email":{"type":"string","description":"An email address.","x-he":"כתובת מייל.","format":"email","maxLength":200},"language":{"type":"string","description":"The language they speak, a two-letter code: en, ar, he, ru…","x-he":"השפה שהם מדברים, בקוד של שתי אותיות: en,‏ ar,‏ he,‏ ru…","maxLength":5}}},"example":{"name":"Elena Petrova","whatsapp":"+971505550147","language":"ru"}}}},"responses":{"201":{"description":"The client.","x-he":"הלקוח.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"}}}},"/clients/{id}":{"get":{"operationId":"getClient","tags":["clients"],"summary":"A client's card","x-summary-he":"כרטיס הלקוח","description":"Their details, what they are looking for, and their deals with each deal's id for `PATCH /deals/{id}`.","x-he":"הפרטים, מה הם מחפשים, והעסקאות שלהם עם המזהה של כל עסקה ל-`PATCH /deals/{id}`.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^c[a-z0-9]{20,32}$"},"description":"The client id from `GET /clients`.","x-he":"מזהה הלקוח מ-`GET /clients`."},{"name":"lang","in":"query","required":false,"schema":{"type":"string","enum":["en","he"],"default":"en"},"description":"The language of place names.","x-he":"השפה של שמות המקומות."}],"responses":{"200":{"description":"The card.","x-he":"הכרטיס.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCard"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/clients/{id}/notes":{"post":{"operationId":"addNote","tags":["clients"],"summary":"A note on a client's card","x-summary-he":"הערה בכרטיס לקוח","description":"Free text on the client's timeline, as the member.","x-he":"טקסט חופשי בציר הזמן של הלקוח, בשם חבר הצוות.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^c[a-z0-9]{20,32}$"},"description":"The client id.","x-he":"מזהה הלקוח."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"additionalProperties":false,"properties":{"text":{"type":"string","description":"The note.","x-he":"ההערה.","minLength":1,"maxLength":4000}}},"example":{"text":"Wants a sea view, budget AED 2M, moving in 2028."}}}},"responses":{"201":{"description":"The note was added.","x-he":"ההערה נוספה.","content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The note id.","x-he":"מזהה ההערה."}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/tasks":{"get":{"operationId":"listTasks","tags":["tasks"],"summary":"Your tasks","x-summary-he":"המשימות שלכם","description":"The member's own tasks, with how many there are in each scope.","x-he":"המשימות של חבר הצוות, עם המספר בכל קבוצה.","parameters":[{"name":"scope","in":"query","required":false,"schema":{"type":"string","enum":["open","overdue","today","upcoming","someday","done"],"default":"open"},"description":"open is every task not done.","x-he":"open הן כל המשימות שלא הושלמו."}],"responses":{"200":{"description":"The tasks.","x-he":"המשימות.","content":{"application/json":{"schema":{"type":"object","required":["tasks","counts"],"properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/Task"}},"counts":{"type":"object","description":"How many tasks in overdue, today, upcoming, someday and done.","x-he":"כמה משימות יש ב-overdue,‏ today,‏ upcoming,‏ someday ו-done.","additionalProperties":{"type":"integer"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"}}},"post":{"operationId":"createTask","tags":["tasks"],"summary":"A new task","x-summary-he":"משימה חדשה","description":"A task at a time, on a day, or with no date; for a client when `clientId` is given.","x-he":"משימה בשעה מסוימת, ביום מסוים או בלי תאריך; של לקוח כשנשלח `clientId`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title"],"additionalProperties":false,"properties":{"title":{"type":"string","description":"What to do.","x-he":"מה צריך לעשות.","minLength":1,"maxLength":200},"note":{"type":"string","description":"More words about it.","x-he":"עוד פרטים.","maxLength":2000},"dueAt":{"type":"string","description":"When: an ISO date-time with its offset, 2026-10-25T11:00:00+04:00. With dueKind DAY, any time on that day.","x-he":"מתי: תאריך ושעה ב-ISO עם ההפרש מ-UTC, ‎2026-10-25T11:00:00+04:00. עם dueKind DAY, כל שעה באותו יום.","maxLength":40},"dueKind":{"type":"string","description":"AT for a time, DAY for a whole day, NONE for no date.","x-he":"AT לשעה, DAY ליום שלם, NONE בלי תאריך.","enum":["AT","DAY","NONE"]},"clientId":{"type":"string","description":"The client the task is for.","x-he":"הלקוח שהמשימה שלו.","pattern":"^c[a-z0-9]{20,32}$"}}},"example":{"title":"Call Elena about Soma Residences","dueAt":"2026-10-25T11:00:00+04:00","dueKind":"AT","clientId":"cm2x8k1qz0001abcdeffghijk"}}}},"responses":{"201":{"description":"The task.","x-he":"המשימה.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/deals/{id}":{"patch":{"operationId":"moveDeal","tags":["deals"],"summary":"Move a deal's stage","x-summary-he":"העברת עסקה לשלב","description":"A deal's id is on its client's card (`GET /clients/{id}`, `deals[].id`).","x-he":"המזהה של עסקה נמצא בכרטיס הלקוח (`GET /clients/{id}`,‏ `deals[].id`).","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^c[a-z0-9]{20,32}$"},"description":"The deal id.","x-he":"מזהה העסקה."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stage"],"additionalProperties":false,"properties":{"stage":{"type":"string","description":"The new stage.","x-he":"השלב החדש.","enum":["NEW","CONTACTED","VIEWING","EOI","BOOKED","WON","LOST"]},"lostReason":{"type":"string","description":"Why it was lost; read only with LOST.","x-he":"למה העסקה אבדה; נקרא רק עם LOST.","maxLength":200}}},"example":{"stage":"VIEWING"}}}},"responses":{"200":{"description":"The deal moved.","x-he":"העסקה הועברה.","content":{"application/json":{"schema":{"type":"object","required":["ok"],"properties":{"ok":{"type":"boolean","const":true}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/brochures":{"post":{"operationId":"createBrochure","tags":["brochures"],"summary":"A brochure link","x-summary-he":"קישור לברושור","description":"A brochure of a project in your brand, with open tracking, for the agent to send. Realton does not send it.","x-he":"ברושור של פרויקט במותג שלכם, עם מעקב פתיחות, לשליחה על ידי הסוכן. Realton לא שולח אותו.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project","lang"],"additionalProperties":false,"properties":{"project":{"type":"string","description":"The project key.","x-he":"מפתח הפרויקט.","pattern":"^(studio|wp|snap):[A-Za-z0-9_.:-]{1,120}$"},"clientId":{"type":"string","description":"The client it is for: their opens show on their card.","x-he":"הלקוח שהקישור בשבילו: הפתיחות יופיעו בכרטיס שלו.","pattern":"^c[a-z0-9]{20,32}$"},"lang":{"type":"string","description":"The language of the brochure.","x-he":"שפת הברושור.","enum":["en","he"]}}},"example":{"project":"studio:soma-residences","clientId":"cm2x8k1qz0001abcdeffghijk","lang":"en"}}}},"responses":{"201":{"description":"The link.","x-he":"הקישור.","content":{"application/json":{"schema":{"type":"object","required":["id","url","project","lang","client"],"properties":{"id":{"type":"string","description":"The link id.","x-he":"מזהה הקישור."},"url":{"type":"string","description":"The address to send: it opens the brochure in the agency's brand.","x-he":"הכתובת לשליחה: היא פותחת את הברושור במותג של הסוכנות."},"project":{"type":"string","description":"The project name.","x-he":"שם הפרויקט."},"lang":{"type":"string","description":"The language of the brochure.","x-he":"שפת הברושור."},"client":{"type":["string","null"],"description":"The client's name, when it is for one.","x-he":"שם הלקוח, אם הקישור בשבילו."}}},"example":{"id":"cm2x9p0aa0002abcdeffghijk","url":"https://realton.ai/b/Hk3…","project":"Soma Residences","lang":"en","client":"Elena Petrova"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}}},"components":{"securitySchemes":{"realtonKey":{"type":"http","scheme":"bearer","description":"A Realton key that opens the REST API, made by an owner or an admin in Settings, API and MCP: `Authorization: Bearer rtk_live_…`. Keep it on your server, never in a page or an app a client can open.","x-he":"מפתח Realton שנותן גישה ל-REST API, שבעלים או מנהל יוצרים בהגדרות, API ו-MCP: `Authorization: Bearer rtk_live_…`. שמרו אותו בשרת שלכם, אף פעם לא בדף או באפליקציה שלקוח יכול לפתוח."}},"schemas":{"Error":{"type":"object","required":["code"],"description":"A refusal: switch on `code`; `message`, when there is one, is a hint in English.","x-he":"סירוב: בודקים את `code`; `message`, כשיש, הוא רמז באנגלית.","properties":{"code":{"type":"string","description":"What went wrong, in a stable word.","x-he":"מה השתבש, במילה קבועה."},"message":{"type":"string","description":"A hint in English.","x-he":"רמז באנגלית."},"retryAfterSec":{"type":"integer","description":"With RATE_LIMITED: seconds until the next call is accepted.","x-he":"עם RATE_LIMITED: כמה שניות עד שקריאה נוספת תתקבל."}}},"ProjectSummary":{"type":"object","properties":{"key":{"type":"string","description":"The project key, for `GET /projects/{key}` and `POST /brochures`.","x-he":"מפתח הפרויקט, ל-`GET /projects/{key}` ול-`POST /brochures`."},"name":{"type":"string","description":"The project's name.","x-he":"שם הפרויקט."},"developer":{"type":["string","null"],"description":"The developer's name.","x-he":"שם היזם."},"market":{"type":["string","null"],"description":"ae, cy, ge, om or sa.","x-he":"ae,‏ cy,‏ ge,‏ om או sa.","enum":["ae","cy","ge","om","sa"]},"place":{"type":["string","null"],"description":"The city or emirate.","x-he":"העיר או האמירות."},"area":{"type":["string","null"],"description":"The area.","x-he":"האזור."},"stage":{"type":["string","null"],"description":"OFF_PLAN, UNDER_CONSTRUCTION or READY.","x-he":"OFF_PLAN,‏ UNDER_CONSTRUCTION או READY.","enum":["OFF_PLAN","UNDER_CONSTRUCTION","READY"]},"handover":{"type":["string","null"],"description":"When it is handed over, as the developer says it: Q4 2028.","x-he":"מתי הוא נמסר, כמו שהיזם אומר: Q4 2028."},"priceFrom":{"type":["number","null"],"description":"The lowest price, in `currency`.","x-he":"המחיר הנמוך ביותר, ב-`currency`."},"currency":{"type":"string","description":"The developer's currency: AED, EUR, USD, OMR, SAR.","x-he":"המטבע של היזם: AED,‏ EUR,‏ USD,‏ OMR,‏ SAR."},"bedrooms":{"type":"array","items":{"type":"integer"},"description":"The bedroom counts it has; 0 is a studio.","x-he":"מספרי חדרי השינה שיש בו; 0 הוא סטודיו."},"commissionPct":{"type":["number","null"],"description":"The agent's commission, in percent.","x-he":"העמלה של הסוכן, באחוזים."},"photo":{"type":["string","null"],"description":"A photo of it.","x-he":"תמונה שלו."}}},"ProjectDetail":{"type":"object","additionalProperties":true,"description":"The project as Realton shows it to the agent. Fields may be added; none is taken away within v1.","x-he":"הפרויקט כמו ש-Realton מציג אותו לסוכן. שדות עשויים להתווסף; אף שדה לא יוסר בגרסה 1.","properties":{"entry":{"type":"object","description":"Its catalog line: the same figures as `GET /projects`, with `title` for the name and slugs for place and area.","x-he":"השורה שלו בקטלוג: אותם נתונים כמו ב-`GET /projects`, עם `title` לשם ו-slugs למקום ולאזור."},"placeName":{"type":["string","null"],"description":"The city or emirate.","x-he":"העיר או האמירות."},"areaName":{"type":["string","null"],"description":"The area.","x-he":"האזור."},"unitTypes":{"type":"array","description":"Each unit type: label, beds, available (from the inventory), sizeSqft, sizeSqm, priceFrom, currency, pricePerArea, areaUnit.","x-he":"כל סוג יחידה: label,‏ beds,‏ available (מהמלאי), sizeSqft,‏ sizeSqm,‏ priceFrom,‏ currency,‏ pricePerArea,‏ areaUnit.","items":{"type":"object"}},"plans":{"type":"array","description":"Payment plans: each with its steps (label, timing, percent, phase) and its share before and after handover.","x-he":"תוכניות תשלום: לכל אחת השלבים (label,‏ timing,‏ percent,‏ phase) והחלק לפני המסירה ואחריה.","items":{"type":"object"}},"dldPct":{"type":["number","null"],"description":"Dubai's registration fee on booking, in percent; null elsewhere.","x-he":"אגרת הרישום של דובאי בהזמנה, באחוזים; null במקומות אחרים."},"amenities":{"type":"array","items":{"type":"string"},"description":"What the project offers.","x-he":"מה הפרויקט מציע."},"gallery":{"type":"object","description":"count, and images with their url.","x-he":"count, ו-images עם ה-url שלהן."},"nearby":{"type":"array","items":{"type":"object"},"description":"Places near it: category, name, km.","x-he":"מקומות קרובים: category,‏ name,‏ km."}}},"ClientRow":{"type":"object","properties":{"id":{"type":"string","description":"The client id.","x-he":"מזהה הלקוח."},"name":{"type":["string","null"],"description":"Their name.","x-he":"השם."},"whatsapp":{"type":["string","null"],"description":"Their number.","x-he":"המספר."},"email":{"type":["string","null"],"description":"Their email.","x-he":"המייל."},"language":{"type":["string","null"],"description":"The language they speak.","x-he":"השפה שהם מדברים."},"source":{"type":"string","description":"Where they came from.","x-he":"מאיפה הם הגיעו."},"stage":{"type":["string","null"],"description":"The stage of their most advanced open deal.","x-he":"השלב של העסקה הפתוחה המתקדמת ביותר שלהם.","enum":["NEW","CONTACTED","VIEWING","EOI","BOOKED","WON","LOST"]},"project":{"type":["string","null"],"description":"The project of that deal.","x-he":"הפרויקט של אותה עסקה."},"lastActivityAt":{"type":"string","description":"The last thing that happened with them, ISO date-time.","x-he":"הדבר האחרון שקרה איתם, תאריך ושעה ב-ISO."},"ownerUserId":{"type":"string","description":"The member they belong to.","x-he":"חבר הצוות שהם שייכים לו."},"openTasks":{"type":"integer","description":"Their open tasks.","x-he":"המשימות הפתוחות שלהם."}}},"Contact":{"type":"object","properties":{"id":{"type":"string","description":"The client id.","x-he":"מזהה הלקוח."},"name":{"type":["string","null"],"description":"Their name.","x-he":"השם."},"language":{"type":["string","null"],"description":"The language they speak.","x-he":"השפה שהם מדברים."},"whatsapp":{"type":["string","null"],"description":"Their number, E.164.","x-he":"המספר, בפורמט E.164."},"email":{"type":["string","null"],"description":"Their email.","x-he":"המייל."},"ownerUserId":{"type":"string","description":"The member they belong to.","x-he":"חבר הצוות שהם שייכים לו."},"updatedAt":{"type":"string","description":"ISO date-time.","x-he":"תאריך ושעה ב-ISO."}}},"ClientCard":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","description":"The client id.","x-he":"מזהה הלקוח."},"name":{"type":["string","null"],"description":"Their name.","x-he":"השם."},"whatsapp":{"type":["string","null"],"description":"Their number.","x-he":"המספר."},"email":{"type":["string","null"],"description":"Their email.","x-he":"המייל."},"language":{"type":["string","null"],"description":"The language they speak.","x-he":"השפה שהם מדברים."},"requirements":{"type":"object","description":"What they are looking for: places, bedrooms, budget, handover.","x-he":"מה הם מחפשים: מקומות, חדרי שינה, תקציב, מסירה."},"ownerName":{"type":["string","null"],"description":"The member they belong to.","x-he":"חבר הצוות שהם שייכים לו."},"deals":{"type":"array","description":"Their deals: id, stage, projectKey, projectTitle, beds, unitLabel, price, currency, commissionPct, commission, lostReason.","x-he":"העסקאות שלהם: id,‏ stage,‏ projectKey,‏ projectTitle,‏ beds,‏ unitLabel,‏ price,‏ currency,‏ commissionPct,‏ commission,‏ lostReason.","items":{"type":"object"}}}},"Task":{"type":"object","properties":{"id":{"type":"string","description":"The task id.","x-he":"מזהה המשימה."},"title":{"type":"string","description":"What to do.","x-he":"מה צריך לעשות."},"note":{"type":["string","null"],"description":"More words about it.","x-he":"עוד פרטים."},"dueAt":{"type":["string","null"],"description":"When, ISO date-time.","x-he":"מתי, תאריך ושעה ב-ISO."},"dueKind":{"type":"string","description":"AT, DAY or NONE.","x-he":"AT,‏ DAY או NONE.","enum":["AT","DAY","NONE"]},"doneAt":{"type":["string","null"],"description":"When it was done.","x-he":"מתי היא הושלמה."},"scope":{"type":"string","description":"Where it stands now, in the member's time zone.","x-he":"איפה היא עומדת עכשיו, באזור הזמן של חבר הצוות.","enum":["overdue","today","upcoming","someday","done"]},"contact":{"type":["object","null"],"description":"The client it is for: id and name.","x-he":"הלקוח שהמשימה שלו: id ו-name."},"dealId":{"type":["string","null"],"description":"The deal it belongs to.","x-he":"העסקה שהיא שייכת לה."}}}},"responses":{"400":{"description":"The request does not hold: a field out of its range, an unknown place or area (`place_unknown`, `area_unknown`), an id that is not one (`bad_id`), a project key that is not one (`project_invalid`), a contact with nothing to reach them (`contact_empty`), a number without its country code (`whatsapp_invalid`), a task without a title (`title_required`) or with a date that is not one (`due_invalid`), a note without text (`text_required`), a stage that is not one (`stage_invalid`).","x-he":"הבקשה לא תקינה: שדה מחוץ לטווח, מקום או אזור לא מוכרים (`place_unknown`,‏ `area_unknown`), מזהה לא תקין (`bad_id`), מפתח פרויקט לא תקין (`project_invalid`), לקוח בלי דרך ליצור קשר (`contact_empty`), מספר בלי קידומת מדינה (`whatsapp_invalid`), משימה בלי כותרת (`title_required`) או עם תאריך לא תקין (`due_invalid`), הערה בלי טקסט (`text_required`), שלב לא תקין (`stage_invalid`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"code":"place_unknown"}}}},"401":{"description":"No key, or a key that is unknown or revoked: `key_required`, `key_invalid`.","x-he":"אין מפתח, או מפתח לא מוכר או מבוטל: `key_required`,‏ `key_invalid`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"code":"key_invalid"}}}},"403":{"description":"The key cannot do this: it does not open the REST API (`key_scope`), the workspace's plan no longer includes it (`plan_required`), or the member who made it has left the workspace (`key_member_gone`).","x-he":"המפתח לא יכול לעשות את זה: הוא לא נותן גישה ל-REST API (`key_scope`), המסלול של סביבת העבודה כבר לא כולל אותו (`plan_required`), או שמי שיצר אותו עזב את סביבת העבודה (`key_member_gone`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"code":"plan_required"}}}},"404":{"description":"Not found, or not the member's to see: `not_found`, `project_not_found`.","x-he":"לא נמצא, או לא שייך לחבר הצוות: `not_found`,‏ `project_not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"code":"not_found"}}}},"429":{"description":"More than 120 calls in a minute with this key. Wait `retryAfterSec` seconds.","x-he":"יותר מ-120 קריאות בדקה עם המפתח הזה. חכו `retryAfterSec` שניות.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"code":"RATE_LIMITED","message":"Too many requests, please slow down.","retryAfterSec":21}}}}}}}