Skip to content
UnisoftDeveloper documentation

REST API / v1

Connect your tools to Unisoft.

Start with a first request, review the essential rules, then explore each documented operation with its parameters and examples.

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

Your first API call

Start with a read request to verify your connection before making any changes.

1. Prepare your key

In the Unisoft back office, open Developers, create an API key, and grant it only the permissions your integration needs. Copy the key when it is created.

2. Choose the right environment

Production and development use separate domains. Use a key created in the environment you are calling.

PRODUCTION=https://api.unisoft.world/integrations/v1
DEVELOPMENT=https://kehilaapi.syn-assist.fr/integrations/v1

3. Verify the connection

export UNISOFT_API_URL='https://api.unisoft.world/integrations/v1'
export UNISOFT_API_KEY='ke_live_REPLACE_WITH_YOUR_KEY'

curl --fail-with-body "$UNISOFT_API_URL/me" \
  --header "Authorization: Bearer $UNISOFT_API_KEY"

GET /me returns the organization, the key’s permissions, and the enabled languages. Check this information before continuing.

Example

{
  "success": true,
  "data": {
    "apiKey": {
      "id": "key_example",
      "name": "Example integration",
      "prefix": "ke_live_",
      "scopes": [
        "contacts:read"
      ]
    },
    "organisation": {
      "id": "org_example",
      "name": "Example organisation",
      "shortName": "Example",
      "defaultLanguage": "fr",
      "enabledLanguages": [
        "fr",
        "en"
      ]
    }
  }
}

4. Read your first contacts

This request requires the contacts:read permission. Available search parameters are listed in the API reference.

curl --fail-with-body "$UNISOFT_API_URL/contacts?limit=10" \
  --header "Authorization: Bearer $UNISOFT_API_KEY"

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