API reference

Apps

API referencehttps://api.contit.cloud

Apps

Endpoints for managing app settings, parameters, and workspace installations.

GET /apps

Get app settings

Retrieve the current app configuration including parameters and field mappings.

Richiede la policy App.ReadAccess

Risposte

200Success
parametersobjectDictionary of app parameter key-value pairs
fieldMappingobjectDictionary of field mapping configurations
401Unauthorized

Esempi di codice

curl -X GET "https://api.contit.cloud/apps" \
  -H "X-Api-Key: YOUR_API_KEY"
Esempio di risposta 200
{
  "parameters": {
    "apiEndpoint": "https://external-api.example.com",
    "syncInterval": "60",
    "enableNotifications": "true"
  },
  "fieldMapping": {
    "externalId": "sku",
    "externalName": "title"
  }
}
Prova Live
GET /apps/{userId}/workspaces/{workspaceId}

Get app settings for user workspace

Retrieve app settings scoped to a specific user and workspace combination.

Richiede la policy App.UserAccess

Parametri del percorso

NomeTipoObbligatorioDescrizione
userIdstringThe user ID
workspaceIdstringThe workspace ID

Risposte

200Success
parametersobjectApp parameters for this user/workspace
fieldMappingobjectField mappings
401Unauthorized
404Not Found

Esempi di codice

curl -X GET "https://api.contit.cloud/apps/{userId}/workspaces/{workspaceId}" \
  -H "X-Api-Key: YOUR_API_KEY"
Esempio di risposta 200
{
  "parameters": {
    "apiEndpoint": "https://external-api.example.com",
    "syncInterval": "60"
  },
  "fieldMapping": {
    "externalId": "sku"
  }
}
Prova Live
POST /apps

Update app parameters

Update the app's configuration parameters. Sends a key-value dictionary that is merged with existing parameters.

Richiede la policy WriteAccess

Corpo della richiesta application/json

ProprietàTipoObbligatorioDescrizione
(key-value pairs) object Dictionary of parameter key-value pairs to set or update

Risposte

200Success — parameters updated
401Unauthorized

Esempi di codice

curl -X POST "https://api.contit.cloud/apps" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "(key-value pairs)": "(key-value pairs)_value"
}'
Esempio di richiesta
{
  "apiEndpoint": "https://new-api.example.com",
  "syncInterval": "120",
  "enableNotifications": "false"
}
Esempio di risposta 200
{
  "success": true
}
Prova Live
GET /apps/workspaces

Get workspaces with app installed

Retrieve the list of workspaces where this app is installed.

Richiede la policy App.ReadAccess

Risposte

200Success
(array)WorkspaceInfo[]Array of workspace information objects
401Unauthorized

Esempi di codice

curl -X GET "https://api.contit.cloud/apps/workspaces" \
  -H "X-Api-Key: YOUR_API_KEY"
Esempio di risposta 200
[
  {
    "id": "ws-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Acme Corp Production",
    "ownerUserId": "usr-b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "planType": "Business",
    "planRecords": 50000,
    "activationDate": "2025-01-15T00:00:00Z",
    "expirationDate": "2026-01-15T00:00:00Z"
  },
  {
    "id": "ws-c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Acme Corp Staging",
    "ownerUserId": "usr-b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "planType": "Developer",
    "planRecords": 5000,
    "activationDate": "2025-06-01T00:00:00Z",
    "expirationDate": "2026-06-01T00:00:00Z"
  }
]
Prova Live
GET /apps/workspaces/all

Get all installed workspaces

Retrieve all workspaces where this app is installed, across all users.

Richiede la policy App.ReadAccess

Risposte

200Success
(array)WorkspaceInfo[]Array of all workspace information objects
401Unauthorized

Esempi di codice

curl -X GET "https://api.contit.cloud/apps/workspaces/all" \
  -H "X-Api-Key: YOUR_API_KEY"
Esempio di risposta 200
[
  {
    "id": "ws-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Acme Corp Production",
    "ownerUserId": "usr-b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "planType": "Business",
    "planRecords": 50000,
    "activationDate": "2025-01-15T00:00:00Z",
    "expirationDate": "2026-01-15T00:00:00Z"
  }
]
Prova Live