EN IT

Apps

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

Base URL: https://api.contit.cloud

GET /apps

Get app settings

Retrieve the current app configuration including parameters and field mappings.

Requires App.ReadAccess policy

Responses

200 Success
parameters object Dictionary of app parameter key-value pairs
fieldMapping object Dictionary of field mapping configurations
401 Unauthorized

Code examples

curl -X GET "https://api.contit.cloud/apps" \
  -H "X-Api-Key: YOUR_API_KEY"
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");

var response = await http.GetAsync("https://api.contit.cloud/apps");

response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

const response = await fetch(
  "https://api.contit.cloud/apps",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "YOUR_API_KEY",
    }
  }
);

const data = await response.json();

import requests

headers = {"X-Api-Key": "YOUR_API_KEY"}

response = requests.get(
    "https://api.contit.cloud/apps",
    headers=headers
)

data = response.json()
Example Response 200 
{
  "parameters": {
    "apiEndpoint": "https://external-api.example.com",
    "syncInterval": "60",
    "enableNotifications": "true"
  },
  "fieldMapping": {
    "externalId": "sku",
    "externalName": "title"
  }
}
Try it Live
GET /apps/{userId}/workspaces/{workspaceId}

Get app settings for user workspace

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

Requires App.UserAccess policy

Path Parameters

NameTypeRequiredDescription
userId string ✓ The user ID
workspaceId string ✓ The workspace ID

Responses

200 Success
parameters object App parameters for this user/workspace
fieldMapping object Field mappings
401 Unauthorized
404 Not Found

Code examples

curl -X GET "https://api.contit.cloud/apps/{userId}/workspaces/{workspaceId}" \
  -H "X-Api-Key: YOUR_API_KEY"
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");

var response = await http.GetAsync("https://api.contit.cloud/apps/{userId}/workspaces/{workspaceId}");

response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

const response = await fetch(
  "https://api.contit.cloud/apps/{userId}/workspaces/{workspaceId}",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "YOUR_API_KEY",
    }
  }
);

const data = await response.json();

import requests

headers = {"X-Api-Key": "YOUR_API_KEY"}

response = requests.get(
    "https://api.contit.cloud/apps/{userId}/workspaces/{workspaceId}",
    headers=headers
)

data = response.json()
Example Response 200 
{
  "parameters": {
    "apiEndpoint": "https://external-api.example.com",
    "syncInterval": "60"
  },
  "fieldMapping": {
    "externalId": "sku"
  }
}
Try it Live
POST /apps

Update app parameters

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

Requires WriteAccess policy

Request Body application/json

PropertyTypeRequiredDescription
(key-value pairs) object ✓ Dictionary of parameter key-value pairs to set or update

Responses

200 Success — parameters updated
401 Unauthorized

Code examples

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"
}'
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");

var content = new StringContent("{
  \"(key-value pairs)\": \"(key-value pairs)_value\"
}",
    Encoding.UTF8, "application/json");
var response = await http.PostAsync(
    "https://api.contit.cloud/apps", content);

response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

const response = await fetch(
  "https://api.contit.cloud/apps",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
  "(key-value pairs)": "(key-value pairs)_value"
})
  }
);

const data = await response.json();

import requests

headers = {"X-Api-Key": "YOUR_API_KEY"}
payload = {
  "(key-value pairs)": "(key-value pairs)_value"
}

response = requests.post(
    "https://api.contit.cloud/apps",
    json=payload,
    headers=headers
)

data = response.json()
Example Request
{
  "apiEndpoint": "https://new-api.example.com",
  "syncInterval": "120",
  "enableNotifications": "false"
}
Example Response 200 
{
  "success": true
}
Try it Live
GET /apps/workspaces

Get workspaces with app installed

Retrieve the list of workspaces where this app is installed.

Requires App.ReadAccess policy

Responses

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

Code examples

curl -X GET "https://api.contit.cloud/apps/workspaces" \
  -H "X-Api-Key: YOUR_API_KEY"
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");

var response = await http.GetAsync("https://api.contit.cloud/apps/workspaces");

response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

const response = await fetch(
  "https://api.contit.cloud/apps/workspaces",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "YOUR_API_KEY",
    }
  }
);

const data = await response.json();

import requests

headers = {"X-Api-Key": "YOUR_API_KEY"}

response = requests.get(
    "https://api.contit.cloud/apps/workspaces",
    headers=headers
)

data = response.json()
Example Response 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"
  }
]
Try it Live
GET /apps/workspaces/all

Get all installed workspaces

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

Requires App.ReadAccess policy

Responses

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

Code examples

curl -X GET "https://api.contit.cloud/apps/workspaces/all" \
  -H "X-Api-Key: YOUR_API_KEY"
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");

var response = await http.GetAsync("https://api.contit.cloud/apps/workspaces/all");

response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

const response = await fetch(
  "https://api.contit.cloud/apps/workspaces/all",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "YOUR_API_KEY",
    }
  }
);

const data = await response.json();

import requests

headers = {"X-Api-Key": "YOUR_API_KEY"}

response = requests.get(
    "https://api.contit.cloud/apps/workspaces/all",
    headers=headers
)

data = response.json()
Example Response 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"
  }
]
Try it Live