Skip to content
UnisoftDeveloper documentation

REST API / v2

Data and pagination

Conventions to check before reading or changing your data.

Documentation environment · Productionhttps://api.unisoft.world/integrations/v2

Browsing a list

Paginated lists return data and meta. Pass meta.nextCursor as cursor while meta.hasMore is true, keeping your filters unchanged. The usual limit is 50 items, with a maximum of 200; check each operation’s parameters.

GET /contacts?limit=50
GET /contacts?limit=50&cursor=NEXT_CURSOR

Amounts and currencies

Payment amounts use minor units: 1500 represents EUR 15.00. Donation pledges use major units. Always check the field schema and its currency.

Editing multilingual content

The organization’s primary language is at the root of the object. Other languages are partial objects under their language codes. Read defaultLanguage and enabledLanguages from GET /me.

{
  "label": "Restaurant",
  "en": {"label": "Restaurant"},
  "he": {"label": "מסעדה"}
}

In a PATCH request, an omitted field remains unchanged. Setting a language overlay to null removes that translation. Deletion rules for other fields depend on their schema.

Multilingual content (read this before writing any text field). Translatable content does NOT use a {fr:…, en:…} map. Instead:

  • The value in the organisation's default language (org.language) sits at the ROOT of the object — never nested under its own language key.
  • Every other language enabled by the org (org.languages) is a partial overlay keyed by its language code, holding only the translatable fields.
{ "label": "Restaurant", "he": { "label": "מסעדה" } }   // org default = French

Valid overlay keys are dynamic per organisation = its enabled languages minus the default one. Sending the default language as an overlay is rejected (it would duplicate the root); an unsupported language is dropped silently. A field missing from an overlay falls back to the root value.

Editing vs deleting a translation — on a partial update (PATCH), omitting a key means "leave it as it is". Therefore:

Body Effect on the he translation
{"he": {"label": "מסעדה"}} created / overwritten
(key omitted) left untouched
{"he": null} deleted (the whole he overlay is removed)
{"he": {}} deleted too — an empty overlay carries no translation

To delete a translation, explicitly send null for that language. An empty translation object is also treated as a deletion; omitting the language preserves its current value.

The default language is gated on the operation, not on the key. Sending it as an overlay to WRITE it is rejected ({"fr": {"label": "…"}} on a French-default org) — the default language belongs at the root. But {"fr": null} is accepted: it DELETES an overlay in that language. This matters when an organisation changes its default language — an overlay in the new default language survives in the documents and takes precedence over the root value when rendered, so deleting it must remain possible. See the I18nOverlay schema.

The detailed reference is available in French and English. Route names, field names, and technical values remain unchanged.