למאמר הדרכה על הגדרות שימוש ב HTTP REST API לחצו כאן.

קבלת כל סוגי הרשומות במערכת:

Method: GET

Action: Records

URL: https://api.fireberry.com/metadata/records

קבלת כל השדות ברשומה מסויימת במערכת:

Method: GET

Action: Records

URL: https://api.fireberry.com/metadata/records/{recordid}/fields

קבלת פרטי שדה מסויים ברשומה מסויימת במערכת:

Method: GET

Action: Records

URL: https://api.fireberry.com/metadata/records/{recordid}/fields/{fieldid}

קבלת כל ערכי תיבת בחירה עבור שדה מסויים במערכת:

Method: GET

Action: Records

URL: https://api.fireberry.com/metadata/records/{recordid}/fields/{fieldid}/values

לדוגמא, נרצה לדעת את כל הפרטים על רשומת לקוח כולל שדות, ואת כל המידע על שדה סטטוס לקוח ועל ערכים שניתן להכניס לשדה זה.

לשם כך נבצע כמה קריאות API לפי הסדר הבא: