1. Overview

This document describes the resources that make up the Clinked API v2. If you have any problems or requests please contact Clinked support.

1.1. Schema

All API access is over HTTPS, and accessed from the https://api.clinked.com. All data is sent and received as JSON.

Blank fields are included as null instead of being omitted.

All timestamps are in milliseconds (UTC):

1518170699654

1.2. User agent

A client must provide a User-Agent header that can help identify your application.

Here’s an example:

User-Agent: Awesome-App

1.3. Authentication

Authentication flow is based on OAuth2 with a few additional steps:

  1. A client authenticates using static client id clinked-mobile and user credentials.

  2. Once authenticated, a client creates a new application using an access token from the previous step.

  3. Once application is created, the API responds with a new randomly generated client id and client secret. These credentials need to be persisted to refresh access token in the future.

  4. A client uses client id and client secret from previous step to authenticate.

The resulting access token is the one that is required to access API resources. Pass it in the Authorization header for each request:

Authorization: Bearer 1da13d89-150c-4c4d-a1a3-36958a7cd551
See our Basics of authentication guide to get you started.
Access token is temporary and available only for 30 minutes, after that the API will respond with 401 Unauthorized. If that’s the case a client should request a new one using same client id and client secret.
A user might revoke an application and the API will respond with 401 Unauthorized even when trying to refresh a token. In that case a user should be considered logged out.

1.3.1. Authenticating with user credentials

Table 1. Request parameters
Parameter Description

client_id

Client id. Always a static value for this grant type: clinked-mobile

grant_type

Grant type

password

Password

username

Username

code

Optional. Two-factor authentication code if required
Example of a request
GET /oauth/token?client_id=clinked-mobile&grant_type=password&password=Aez1Ahr8Ji&username=jack&code=12345 HTTP/1.1
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/oauth/token?client_id=clinked-mobile&grant_type=password&password=Aez1Ahr8Ji&username=jack&code=12345' -i -X GET \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
    "access_token": "f3a5837f-7a28-4148-9352-336e0bca75a9",
    "refresh_token": "e10560b0-9bdc-478e-a2dc-95009c419a40",
    "scope": "read write",
    "token_type": "bearer"
}

1.3.2. Creating an application

Table 2. Request fields
Path Type Description

deviceType

String

Device type: [Phone, Tablet, Watch, Browser, Other]

appVersion

String

Version

name

String

Name

bundleId

String

Bundle/package name

description

String

Description

deviceModel

String

Device model name

deviceToken

String

Device Firebase Cloud Messaging token for notifications

platform

String

Device platform: [IOS, ANDROID, SYNC, LINUX, WINDOWS, OTHER]

deviceOs

String

Device operating system name
Example of a request
POST /v2/applications HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 307

{
  "deviceType" : "Phone",
  "appVersion" : "1.0",
  "deviceOs" : "Android",
  "name" : "Awesome App",
  "bundleId" : "com.clinked.awesome",
  "description" : "This is my awesome app",
  "deviceModel" : "Google Pixel XL",
  "platform" : "ANDROID",
  "deviceToken" : "2ba848d4-1c58-4451-912b-60c5b9732cf7"
}
$ curl 'https://api.clinked.com/v2/applications' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "deviceType" : "Phone",
  "appVersion" : "1.0",
  "deviceOs" : "Android",
  "name" : "Awesome App",
  "bundleId" : "com.clinked.awesome",
  "description" : "This is my awesome app",
  "deviceModel" : "Google Pixel XL",
  "platform" : "ANDROID",
  "deviceToken" : "2ba848d4-1c58-4451-912b-60c5b9732cf7"
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1581

{
  "id" : null,
  "owner" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 500,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "clientId" : "79df4f5fb1e6437a36456aeea5bb5242",
  "clientSecret" : "40a3d77b5ca14b1094619a3031149577",
  "scope" : [ "read", "write", "smartsync" ],
  "name" : "Awesome App",
  "description" : "This is my awesome app",
  "platform" : "ANDROID",
  "deviceType" : "Phone",
  "deviceModel" : "Google Pixel XL",
  "deviceOs" : "Android",
  "appVersion" : "1.0",
  "bundleId" : "com.clinked.awesome",
  "deviceToken" : "2ba848d4-1c58-4451-912b-60c5b9732cf7",
  "lastActivity" : null,
  "ip" : null,
  "authorities" : [ {
    "authority" : "ROLE_CLIENT"
  }, {
    "authority" : "READ"
  }, {
    "authority" : "WRITE"
  }, {
    "authority" : "SMARTSYNC"
  } ],
  "registeredRedirectUri" : [ ]
}
Fields are defined in Get single application

1.3.3. Authenticating with client credentials

Table 3. Request parameters
Parameter Description

client_id

Client id

client_secret

Client secret

grant_type

Grant type

scope

Scope. Normally should be read write
Example of a request
GET /oauth/token?client_id=5ad29f13-82b8-4b68-89e6-c2f4c96d5d9d&client_secret=0eda391b-0a88-46d2-aaaf-905332c19e20&grant_type=client_credentials&scope=read+write HTTP/1.1
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/oauth/token?client_id=5ad29f13-82b8-4b68-89e6-c2f4c96d5d9d&client_secret=0eda391b-0a88-46d2-aaaf-905332c19e20&grant_type=client_credentials&scope=read+write' -i -X GET \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
    "access_token": "2466f2ee-0875-41a1-ad6c-8f81468f47e9",
    "token_type": "bearer",
    "expires_in": 7199,
    "scope": "read write"
}

1.4. Forbidden names

Some names are reserved and not allowed to use.

1.5. Rate limit

Maximum number of requests is 2000 from a single IP address in 5 minute period. This value is continually evaluated, and requests will be blocked once this limit is reached. The IP address is automatically unblocked after it falls below the limit.

2. Organisation

Organisation (sometimes referred as an "account") is a holder for multiple groups. You need to know id of an organisation to use the following resources.

2.1. Data

Organisation holds data such as package and customizations.

2.1.1. List organisations

This resource returns a list of organisations user is part of.

Example of a request
GET /v2/accounts HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1808

[ {
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 412,
    "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
    "objectId" : 1
  },
  "creator" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 603,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "name" : "awesome_org",
  "friendlyName" : "Awesome Organisation",
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "enabled" : true,
  "domain" : null,
  "mobileSchema" : null,
  "branding" : {
    "backgroundColor" : "#ffffff",
    "textColor" : "#ff0000",
    "logo" : false,
    "logoLarge" : false,
    "logoMedium" : false,
    "background" : false,
    "favicon" : false,
    "textLogo" : false,
    "gradient" : false,
    "gradientWidth" : 400
  },
  "samlConfiguration" : {
    "entityId" : null,
    "ssoEnabled" : false,
    "userJit" : true,
    "forceSso" : false,
    "adminsUsePassword" : true,
    "disableProfileEdit" : false,
    "forceAuth" : false
  },
  "hash" : null,
  "locale" : null,
  "type" : "account"
} ]
List item fields are defined in Get a single organisation data

2.1.2. Get a single organisation data

View extended details for an organisation.

Table 4. /v2/accounts/{organisation}
Parameter Description

organisation

Organisation/account id
Example of a request
GET /v2/accounts/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1804

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 601,
    "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
    "objectId" : 1
  },
  "creator" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 319,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "name" : "awesome_org",
  "friendlyName" : "Awesome Organisation",
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "enabled" : true,
  "domain" : null,
  "mobileSchema" : null,
  "branding" : {
    "backgroundColor" : "#ffffff",
    "textColor" : "#ff0000",
    "logo" : false,
    "logoLarge" : false,
    "logoMedium" : false,
    "background" : false,
    "favicon" : false,
    "textLogo" : false,
    "gradient" : false,
    "gradientWidth" : 400
  },
  "samlConfiguration" : {
    "entityId" : null,
    "ssoEnabled" : false,
    "userJit" : true,
    "forceSso" : false,
    "adminsUsePassword" : true,
    "disableProfileEdit" : false,
    "forceAuth" : false
  },
  "hash" : null,
  "locale" : null,
  "type" : "account"
}
Table 5. Definition of the returned fields
Path Type Description

id

Number

Organisation id

creator

Object

Creator user

name

String

Unique name

friendlyName

String

Full name

dateCreated

Number

Creation date

lastModified

Number

Last modification date

enabled

Boolean

Is account enabled

samlConfiguration

Object

SAML configuration

branding.backgroundColor

String

Branding background color

branding.textColor

String

Branding text color

branding.logo

Boolean

Has logo

branding.logoLarge

Boolean

Has large size logo

branding.logoMedium

Boolean

Has medium size logo

branding.favicon

Boolean

Has custom favicon

branding.gradient

Boolean

Has gradient applied to background image

branding.gradientWidth

Number

The horizontal width of the gradient over the background image

2.1.3. Get custom component names

Some organisations require naming customisations.

Table 6. /v2/accounts/{organisation}/custom
Parameter Description

organisation

Organisation/account id
Example of a request
GET /v2/accounts/1/custom HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/custom' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 3

{ }
Table 7. Definition of the returned fields
Path Type Description

naming.events.singular

String

Events component singular name

naming.discussions.singular

String

Discussions component singular name

naming.files.singular

String

Files component singular name

naming.pages.singular

String

Notes component singular name

naming.tasks.singular

String

Tasks component singular name

naming.events.plural

String

Events component plural name

naming.discussions.plural

String

Discussions component plural name

naming.files.plural

String

Files component plural name

naming.pages.plural

String

Notes component plural name

naming.tasks.plural

String

Tasks component plural name

naming.shortcuts.plural

String

Shortcuts component plural name

2.2. Groups

2.2.1. List groups

View list of all organisation groups.

Table 8. /v2/accounts/{organisation}/groups
Parameter Description

organisation

Organisation/account id
Example of a request
GET /v2/accounts/1/groups HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/groups' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 4569

[ {
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 985,
    "objectType" : "com.rabbitsoft.clinked.domain.Space",
    "objectId" : 1
  },
  "master" : null,
  "owner" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 890,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "name" : "explore_clinked",
  "friendlyName" : "Explore Clinked",
  "members" : 0,
  "branding" : {
    "headerColor" : "#ffffff",
    "textColor" : "#ff0000",
    "logo" : false,
    "background" : false,
    "alignment" : "left",
    "backgroundPositionX" : 50,
    "backgroundPositionY" : 50,
    "hideBackgroundGradient" : false,
    "hideLogoBackground" : false,
    "hideGroupName" : false
  },
  "storageConsumed" : 0,
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "mailKey" : null,
  "order" : null,
  "hash" : null,
  "components" : [ {
    "name" : "files",
    "order" : 0,
    "configuration" : { }
  }, {
    "name" : "pages",
    "order" : 1,
    "configuration" : { }
  }, {
    "name" : "events",
    "order" : 2,
    "configuration" : { }
  }, {
    "name" : "tasks",
    "order" : 3,
    "configuration" : { }
  }, {
    "name" : "activity",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "chat",
    "order" : null,
    "configuration" : { }
  } ],
  "masterConfiguration" : null,
  "blind" : false,
  "disableChat" : false,
  "disableComments" : false,
  "disableEmailComments" : false,
  "hideMemberDetails" : false,
  "disableAccordionWidgets" : true,
  "duplicate" : false,
  "watermarkConfiguration" : {
    "enableWatermark" : false,
    "enableWatermarkIp" : false,
    "enableWatermarkEmail" : false,
    "enableWatermarkTimestamp" : false,
    "enableWatermarkCustomText" : false,
    "watermarkCustomText" : null,
    "watermarkStyle" : null
  },
  "type" : "group",
  "account" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 18,
      "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
      "objectId" : 1
    },
    "creator" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 346,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "awesome_org",
    "friendlyName" : "Awesome Organisation",
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "enabled" : true,
    "domain" : null,
    "mobileSchema" : null,
    "branding" : {
      "backgroundColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "logoLarge" : false,
      "logoMedium" : false,
      "background" : false,
      "favicon" : false,
      "textLogo" : false,
      "gradient" : false,
      "gradientWidth" : 400
    },
    "samlConfiguration" : {
      "entityId" : null,
      "ssoEnabled" : false,
      "userJit" : true,
      "forceSso" : false,
      "adminsUsePassword" : true,
      "disableProfileEdit" : false,
      "forceAuth" : false
    },
    "hash" : null,
    "locale" : null,
    "type" : "account"
  }
} ]
List item fields are defined in Get a single group data

2.2.2. Get a single group data

View extended details for a single group.

Table 9. /v2/accounts/{organisation}/groups/{space}
Parameter Description

organisation

Organisation/account id

space

Space/group id
Example of a request
GET /v2/accounts/1/groups/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 4566

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 277,
    "objectType" : "com.rabbitsoft.clinked.domain.Space",
    "objectId" : 1
  },
  "master" : null,
  "owner" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 268,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "name" : "explore_clinked",
  "friendlyName" : "Explore Clinked",
  "members" : 0,
  "branding" : {
    "headerColor" : "#ffffff",
    "textColor" : "#ff0000",
    "logo" : false,
    "background" : false,
    "alignment" : "left",
    "backgroundPositionX" : 50,
    "backgroundPositionY" : 50,
    "hideBackgroundGradient" : false,
    "hideLogoBackground" : false,
    "hideGroupName" : false
  },
  "storageConsumed" : 0,
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "mailKey" : null,
  "order" : null,
  "hash" : null,
  "components" : [ {
    "name" : "files",
    "order" : 0,
    "configuration" : { }
  }, {
    "name" : "pages",
    "order" : 1,
    "configuration" : { }
  }, {
    "name" : "events",
    "order" : 2,
    "configuration" : { }
  }, {
    "name" : "tasks",
    "order" : 3,
    "configuration" : { }
  }, {
    "name" : "activity",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "chat",
    "order" : null,
    "configuration" : { }
  } ],
  "masterConfiguration" : null,
  "blind" : false,
  "disableChat" : false,
  "disableComments" : false,
  "disableEmailComments" : false,
  "hideMemberDetails" : false,
  "disableAccordionWidgets" : true,
  "duplicate" : false,
  "watermarkConfiguration" : {
    "enableWatermark" : false,
    "enableWatermarkIp" : false,
    "enableWatermarkEmail" : false,
    "enableWatermarkTimestamp" : false,
    "enableWatermarkCustomText" : false,
    "watermarkCustomText" : null,
    "watermarkStyle" : null
  },
  "type" : "group",
  "account" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 432,
      "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
      "objectId" : 1
    },
    "creator" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 225,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "awesome_org",
    "friendlyName" : "Awesome Organisation",
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "enabled" : true,
    "domain" : null,
    "mobileSchema" : null,
    "branding" : {
      "backgroundColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "logoLarge" : false,
      "logoMedium" : false,
      "background" : false,
      "favicon" : false,
      "textLogo" : false,
      "gradient" : false,
      "gradientWidth" : 400
    },
    "samlConfiguration" : {
      "entityId" : null,
      "ssoEnabled" : false,
      "userJit" : true,
      "forceSso" : false,
      "adminsUsePassword" : true,
      "disableProfileEdit" : false,
      "forceAuth" : false
    },
    "hash" : null,
    "locale" : null,
    "type" : "account"
  }
}
Table 10. Definition of the returned fields
Path Type Description

id

Number

Group id

master

Null

Master group id

masterConfiguration

Null

Master group synchronization configuration

owner

Object

Owner user

name

String

Group unique name

friendlyName

String

Group friendly name

members

Number

Amount of group members

branding.headerColor

String

Header background color

branding.textColor

String

Text color

branding.logo

Boolean

Logo exists

branding.alignment

String

Logo alignment

branding.background

Boolean

Background exists

branding.backgroundPositionX

Number

Background image X position

branding.backgroundPositionY

Number

Background image Y position

components

Array

Components

storageConsumed

Number

Amount of storage consumed

dateCreated

Number

Creation date

lastModified

Number

Last modification time

disableChat

Boolean

Chat disabled

disableComments

Boolean

Content comments disabled

disableAccordionWidgets

Boolean

Recent, Created by, I follow widgets disabled

disableEmailComments

Boolean

Comments conversation in e-mail notifications are disabled

hideMemberDetails

Boolean

Hide member profile details from other members

account

Object

Organisation/account a group belongs to

watermarkConfiguration

Object

Watermark configurations specific for a space

2.2.3. Create a group

Creates a new group for an organisation.

Table 11. /v2/accounts/{organisation}/groups
Parameter Description

organisation

Organisation/account id
Table 12. Request fields
Path Type Description

name

String

Group unique name

friendlyName

String

Group friendly name

branding.headerColor

String

Header background color

branding.textColor

String

Text color

branding.logo

Boolean

Logo exists

branding.background

Boolean

Background exists

branding.backgroundPositionX

Number

Background image X position

branding.backgroundPositionY

Number

Background image Y position

branding.alignment

String

Logo alignment

branding.hideBackgroundGradient

Boolean

Hide background gradient in foreground

branding.hideLogoBackground

Boolean

Hide background for the logo

branding.hideGroupName

Boolean

Hide group name, show only logo

disableChat

Boolean

Chat disabled

disableWidgets

Boolean

Home widgets disabled

disableComments

Boolean

Content comments disabled

disableAccordionWidgets

Boolean

Recent, Created by, I follow widgets disabled

components

Array

Enabled components
Example of a request
POST /v2/accounts/1/groups HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 580

{
  "disableAccordionWidgets" : false,
  "components" : [ "files", "pages", "discussions", "events", "tasks" ],
  "disableChat" : false,
  "disableWidgets" : false,
  "branding" : {
    "headerColor" : "#ffffff",
    "textColor" : "#ff0000",
    "logo" : false,
    "background" : false,
    "alignment" : "left",
    "backgroundPositionX" : 50,
    "backgroundPositionY" : 50,
    "hideBackgroundGradient" : false,
    "hideLogoBackground" : false,
    "hideGroupName" : false
  },
  "name" : "explore_clinked",
  "friendlyName" : "Explore Clinked",
  "disableComments" : false
}
$ curl 'https://api.clinked.com/v2/accounts/1/groups' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "disableAccordionWidgets" : false,
  "components" : [ "files", "pages", "discussions", "events", "tasks" ],
  "disableChat" : false,
  "disableWidgets" : false,
  "branding" : {
    "headerColor" : "#ffffff",
    "textColor" : "#ff0000",
    "logo" : false,
    "background" : false,
    "alignment" : "left",
    "backgroundPositionX" : 50,
    "backgroundPositionY" : 50,
    "hideBackgroundGradient" : false,
    "hideLogoBackground" : false,
    "hideGroupName" : false
  },
  "name" : "explore_clinked",
  "friendlyName" : "Explore Clinked",
  "disableComments" : false
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1752

{
  "id" : null,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : null,
  "master" : null,
  "owner" : null,
  "name" : "explore_clinked",
  "friendlyName" : "Explore Clinked",
  "members" : 0,
  "branding" : {
    "headerColor" : "#ffffff",
    "textColor" : "#ff0000",
    "logo" : false,
    "background" : false,
    "alignment" : "left",
    "backgroundPositionX" : 50,
    "backgroundPositionY" : 50,
    "hideBackgroundGradient" : false,
    "hideLogoBackground" : false,
    "hideGroupName" : false
  },
  "storageConsumed" : 0,
  "dateCreated" : null,
  "lastModified" : null,
  "mailKey" : null,
  "order" : null,
  "hash" : null,
  "components" : [ {
    "name" : "pages",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "activity",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "files",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "discussions",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "chat",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "tasks",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "events",
    "order" : null,
    "configuration" : { }
  } ],
  "masterConfiguration" : null,
  "blind" : false,
  "disableChat" : false,
  "disableComments" : false,
  "disableEmailComments" : false,
  "hideMemberDetails" : false,
  "disableAccordionWidgets" : false,
  "duplicate" : false,
  "watermarkConfiguration" : {
    "enableWatermark" : false,
    "enableWatermarkIp" : false,
    "enableWatermarkEmail" : false,
    "enableWatermarkTimestamp" : false,
    "enableWatermarkCustomText" : false,
    "watermarkCustomText" : null,
    "watermarkStyle" : null
  },
  "type" : "group",
  "account" : null
}
Response fields are defined in Get a single group data

2.2.4. Update a group

Changing group data and settings.

Table 13. /v2/accounts/{organisation}/groups/{space}
Parameter Description

organisation

Organisation/account id

space

Space/group id
Example of a request
POST /v2/accounts/1/groups/1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 580

{
  "disableAccordionWidgets" : false,
  "components" : [ "files", "pages", "discussions", "events", "tasks" ],
  "disableChat" : false,
  "disableWidgets" : false,
  "branding" : {
    "headerColor" : "#ffffff",
    "textColor" : "#ff0000",
    "logo" : false,
    "background" : false,
    "alignment" : "left",
    "backgroundPositionX" : 50,
    "backgroundPositionY" : 50,
    "hideBackgroundGradient" : false,
    "hideLogoBackground" : false,
    "hideGroupName" : false
  },
  "name" : "explore_clinked",
  "friendlyName" : "Explore Clinked",
  "disableComments" : false
}
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "disableAccordionWidgets" : false,
  "components" : [ "files", "pages", "discussions", "events", "tasks" ],
  "disableChat" : false,
  "disableWidgets" : false,
  "branding" : {
    "headerColor" : "#ffffff",
    "textColor" : "#ff0000",
    "logo" : false,
    "background" : false,
    "alignment" : "left",
    "backgroundPositionX" : 50,
    "backgroundPositionY" : 50,
    "hideBackgroundGradient" : false,
    "hideLogoBackground" : false,
    "hideGroupName" : false
  },
  "name" : "explore_clinked",
  "friendlyName" : "Explore Clinked",
  "disableComments" : false
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 4658

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 74,
    "objectType" : "com.rabbitsoft.clinked.domain.Space",
    "objectId" : 1
  },
  "master" : null,
  "owner" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 78,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "name" : "explore_clinked",
  "friendlyName" : "Explore Clinked",
  "members" : 0,
  "branding" : {
    "headerColor" : "#ffffff",
    "textColor" : "#ff0000",
    "logo" : false,
    "background" : false,
    "alignment" : "left",
    "backgroundPositionX" : 50,
    "backgroundPositionY" : 50,
    "hideBackgroundGradient" : false,
    "hideLogoBackground" : false,
    "hideGroupName" : false
  },
  "storageConsumed" : 0,
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "mailKey" : null,
  "order" : null,
  "hash" : null,
  "components" : [ {
    "name" : "pages",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "activity",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "files",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "discussions",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "chat",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "tasks",
    "order" : null,
    "configuration" : { }
  }, {
    "name" : "events",
    "order" : null,
    "configuration" : { }
  } ],
  "masterConfiguration" : null,
  "blind" : false,
  "disableChat" : false,
  "disableComments" : false,
  "disableEmailComments" : false,
  "hideMemberDetails" : false,
  "disableAccordionWidgets" : false,
  "duplicate" : false,
  "watermarkConfiguration" : {
    "enableWatermark" : false,
    "enableWatermarkIp" : false,
    "enableWatermarkEmail" : false,
    "enableWatermarkTimestamp" : false,
    "enableWatermarkCustomText" : false,
    "watermarkCustomText" : null,
    "watermarkStyle" : null
  },
  "type" : "group",
  "account" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 909,
      "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
      "objectId" : 1
    },
    "creator" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 804,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "awesome_org",
    "friendlyName" : "Awesome Organisation",
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "enabled" : true,
    "domain" : null,
    "mobileSchema" : null,
    "branding" : {
      "backgroundColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "logoLarge" : false,
      "logoMedium" : false,
      "background" : false,
      "favicon" : false,
      "textLogo" : false,
      "gradient" : false,
      "gradientWidth" : 400
    },
    "samlConfiguration" : {
      "entityId" : null,
      "ssoEnabled" : false,
      "userJit" : true,
      "forceSso" : false,
      "adminsUsePassword" : true,
      "disableProfileEdit" : false,
      "forceAuth" : false
    },
    "hash" : null,
    "locale" : null,
    "type" : "account"
  }
}
Response fields are defined in Get a single group data

2.2.5. Delete a group

Removes a single group by placing it to trash.

Table 14. /v2/accounts/{organisation}/groups/{space}
Parameter Description

organisation

Organisation/account id

space

Space/group id
Example of a request
DELETE /v2/accounts/1/groups/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1' -i -X DELETE \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK

2.2.6. Duplicate group

Duplicates a group.

Table 15. /v2/accounts/{organisation}/groups/{space}/duplicate
Parameter Description

organisation

Organisation/account id

space

Space/group id
Table 16. Request fields
Parameter Description

duplicateName

New name for a duplicate
Example of a request
GET /v2/accounts/1/groups/1/duplicate?duplicateName=New+Group+Name HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/duplicate?duplicateName=New+Group+Name' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'
Example of a success response
HTTP/1.1 202 Accepted

2.2.7. Permission masks

This section shows supported permission numbers and their description.

Account level permission masks

Permission masks that can be assigned to a user on account level.

1

Member (regular member)

4

Group creator (can create new groups)

16

Super administrator (can create and see all account groups, and manage account settings)
Group level permission masks

Permission masks that can be assigned to a user on group level.

1

Basic (read only)

4

Standard (read and write)

16

Group administrator
Content level permission masks

Permission masks that can be assigned to a user on specific content (e.g. a file) basis.

1

View only

2

View, download and share (if applicable)

4

View and edit

8

View, edit and delete

16

Administer (no restrictions)

2.3. Members

Administrator permission is required to manage organisation members.

2.3.1. List members

List of current organisation members. Result is paginated.

Table 17. /v2/accounts/{organisation}/members
Parameter Description

organisation

Organisation/account id
Table 18. Request parameters
Parameter Description

page

The page to retrieve

pageSize

Entries per page
Example of a request
GET /v2/accounts/1/members HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/members' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1118

{
  "currentPage" : 1,
  "totalResults" : 1,
  "pageSize" : 10,
  "totalPages" : 1,
  "page" : [ {
    "user" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 510,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "accountPermission" : 1
  } ],
  "nextPage" : false,
  "previousPage" : false
}
Table 19. Definition of the returned fields
Path Type Description

currentPage

Number

Current page

pageSize

Number

Entries per page

nextPage

Boolean

Next page exists

page

Array

Page entries

totalPages

Number

Total amount of available pages

nextPage

Boolean

Next page exists

previousPage

Boolean

Previous page exists

totalResults

Number

Total amount of entries
Page entry fields are defined in Get single member data.

2.3.2. Get single member data

Single member data.

Table 20. /v2/accounts/{organisation}/members/{username}
Parameter Description

organisation

Organisation/account id

username

Username of a user to retrieve
Example of a request
GET /v2/accounts/1/members/jack HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/members/jack' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 899

{
  "user" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 926,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "accountPermission" : 1
}
Table 21. Definition of the returned fields
Path Type Description

user.id

Number

User id

user.username

String

Unique username

user.address

String

Address

user.name

String

Full name

user.email

String

E-mail address

user.enabled

Boolean

Enabled and can sign in

user.telephone

String

Phone number

user.organisation

String

Organisation name user works in

user.jobTitle

String

Job title

user.locked

Boolean

Locked and can’t sign in

user.twoFactorAuthentication

Boolean

2FA is enabled

user.twoFactorMode

String

2FA mode - either SMS or Authenticator

user.lastModified

Number

Last modification date (timestamp in milliseconds)

user.lastLogin

Number

Last sign in date (timestamp in milliseconds)

user.lastActive

Number

Last date time the user was active (timestamp in milliseconds)

user.dateActivated

Number

Activation date (timestamp in milliseconds)

user.dateCreated

Number

Creation date (timestamp in milliseconds)

user.timeZone

String

Local time zone name

user.timeZoneOffset

Number

Local time zone offset

user.locale

String

Locale

user.verifiedEmail

Boolean

Is E-mail address verified

accountPermission

Number

Account permission mask

groups

Object

Map of group:permission

2.3.3. Create a member

Single member creation. This example also adds newly created user to a group named my_group with read, write & create permissions.

Table 22. /v2/accounts/{organisation}/members
Parameter Description

organisation

Organisation/account id
Table 23. Request fields
Path Type Description

user.username

String

Unique username

user.password

String

Raw password

user.address

String

Address

user.name

String

Full name

user.email

String

E-mail address

user.enabled

String

Enabled and can sign in

user.telephone

String

Phone number

user.organisation

String

Organisation name user works in

user.jobTitle

String

Job title

accountPermission

Number

Account permission mask

groups

Object

Map of group:permission

activationMessage

String

Activation message

activationDate

Number

Activation date in the future

activationType

String

Activation type: 'now' or 'custom'
Example of a request
POST /v2/accounts/1/members HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 322

{
  "user" : {
    "username" : "new.user",
    "password" : "iuWo9oog1I",
    "name" : "Jack Bauer",
    "email" : "jack.bauer@clinked.com"
  },
  "accountPermission" : 4,
  "groups" : {
    "my_group" : 1
  },
  "activationType" : "now",
  "activationDate" : 1684392072428,
  "activationMessage" : "Activation message"
}
$ curl 'https://api.clinked.com/v2/accounts/1/members' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "user" : {
    "username" : "new.user",
    "password" : "iuWo9oog1I",
    "name" : "Jack Bauer",
    "email" : "jack.bauer@clinked.com"
  },
  "accountPermission" : 4,
  "groups" : {
    "my_group" : 1
  },
  "activationType" : "now",
  "activationDate" : 1684392072428,
  "activationMessage" : "Activation message"
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 900

{
  "user" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 211,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "accountPermission" : 16
}
Table 24. Definition of the returned fields
Path Type Description

user.id

Number

User id

user.username

String

Unique username

user.address

String

Address

user.name

String

Full name

user.email

String

E-mail address

user.enabled

Boolean

Enabled and can sign in

user.telephone

String

Phone number

user.organisation

String

Organisation name user works in

user.jobTitle

String

Job title

user.locked

Boolean

Locked and can’t sign in

user.twoFactorAuthentication

Boolean

2FA is enabled

user.twoFactorMode

String

2FA mode - either SMS or Authenticator

user.lastModified

Number

Last modification date (timestamp in milliseconds)

user.lastLogin

Number

Last sign in date (timestamp in milliseconds)

user.lastActive

Number

Last date time the user was active (timestamp in milliseconds)

user.dateActivated

Number

Activation date (timestamp in milliseconds)

user.dateCreated

Number

Creation date (timestamp in milliseconds)

user.timeZone

String

Local time zone name

user.timeZoneOffset

Number

Local time zone offset

user.locale

String

Locale

user.verifiedEmail

Boolean

Is E-mail address verified

accountPermission

Number

Account permission mask

2.3.4. Update a member

Changing member data.

Table 25. /v2/accounts/{organisation}/members/{username}
Parameter Description

organisation

Organisation/account id

username

Username of a user to update
Table 26. Request fields
Path Type Description

user.username

String

Unique username

user.password

String

Raw password

user.address

String

Address

user.name

String

Full name

user.email

String

E-mail address

user.enabled

String

Enabled and can sign in

user.telephone

String

Phone number

user.organisation

String

Organisation name user works in

user.jobTitle

String

Job title

accountPermission

Number

Account permission mask

groups

Object

Map of group:permission

activationMessage

String

Activation message

activationDate

Number

Activation date in the future

activationType

String

Activation type: 'now' or 'custom'
Example of a request
POST /v2/accounts/1/members/jack HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 324

{
  "user" : {
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "enabled" : true,
    "password" : "iuWo9oog1I",
    "name" : "name",
    "email" : "valid@email.local"
  },
  "accountPermission" : 1,
  "groups" : {
    "my_group" : 1
  }
}
$ curl 'https://api.clinked.com/v2/accounts/1/members/jack' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "user" : {
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "enabled" : true,
    "password" : "iuWo9oog1I",
    "name" : "name",
    "email" : "valid@email.local"
  },
  "accountPermission" : 1,
  "groups" : {
    "my_group" : 1
  }
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 888

{
  "user" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 650,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "name",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "valid@email.local",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "accountPermission" : 1
}
Table 27. Definition of the returned fields
Path Type Description

user.id

Number

User id

user.username

String

Unique username

user.address

String

Address

user.name

String

Full name

user.email

String

E-mail address

user.enabled

Boolean

Enabled and can sign in

user.telephone

String

Phone number

user.organisation

String

Organisation name user works in

user.jobTitle

String

Job title

user.locked

Boolean

Locked and can’t sign in

user.twoFactorAuthentication

Boolean

2FA is enabled

user.twoFactorMode

String

2FA mode - either SMS or Authenticator

user.lastModified

Number

Last modification date (timestamp in milliseconds)

user.lastLogin

Number

Last sign in date (timestamp in milliseconds)

user.lastActive

Number

Last date time the user was active (timestamp in milliseconds)

user.dateActivated

Number

Activation date (timestamp in milliseconds)

user.dateCreated

Number

Creation date (timestamp in milliseconds)

user.timeZone

String

Local time zone name

user.timeZoneOffset

Number

Local time zone offset

user.locale

String

Locale

user.verifiedEmail

Boolean

Is E-mail address verified

accountPermission

Number

Account permission mask

groups

Object

Map of group:permission

2.3.5. Delete a member

Deleting a member. If a user has no organisations any more it will be automatically deleted from the system.

Deleted user can’t be restored.
Table 28. /v2/accounts/{organisation}/members/{username}
Parameter Description

organisation

Organisation/account id

username

Username of a user to delete
Example of a request
DELETE /v2/accounts/1/members/jack HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/members/jack' -i -X DELETE \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK

3. Group

A group (sometimes referred as "space") is an isolated entity that belongs to an organisation. Each group has its own content such as files, notes, etc.

3.1. Files

3.1.1. List files

List visible files in a group folder. Result is paginated.

Table 29. Request parameters
Parameter Description

page

The page to retrieve

pageSize

Entries per page

order.name

Order by name

order.lastModified

Order by modification date

order.size

Order by size

condition.name

Search by name

modifiedSince

Retrieve files that were modified after the date (timestamp in milliseconds)

folder

Retrieve folders only (excludes other files)
Top level folder

Uploads a file to the group top level folder.

Table 30. /v2/accounts/{organisation}/groups/{space}/files
Parameter Description

organisation

Organisation/account id

space

Space/group id
Example of a request
GET /v2/accounts/1/groups/1/files HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 13886

{
  "currentPage" : 1,
  "pageSize" : 25,
  "nextPage" : false,
  "page" : [ {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 507,
      "objectType" : "com.rabbitsoft.clinked.domain.FileRecord",
      "objectId" : 1
    },
    "name" : "example_folder",
    "friendlyName" : "Example Folder",
    "description" : null,
    "watermark" : false,
    "contentType" : "@folder",
    "size" : 0,
    "uploaded" : {
      "user" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 165,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "Jack Bauer"
    },
    "versions" : 0,
    "sharing" : "NONE",
    "memberPermission" : 2,
    "hidden" : false,
    "tags" : null,
    "locked" : false,
    "locker" : null,
    "dateLocked" : null,
    "lastModified" : 1514764800000,
    "previewInfo" : null,
    "inputStream" : null,
    "path" : [ ],
    "available" : true,
    "type" : "file",
    "parent" : null,
    "group" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 237,
        "objectType" : "com.rabbitsoft.clinked.domain.Space",
        "objectId" : 1
      },
      "master" : null,
      "owner" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 177,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "explore_clinked",
      "friendlyName" : "Explore Clinked",
      "members" : 0,
      "branding" : {
        "headerColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "background" : false,
        "alignment" : "left",
        "backgroundPositionX" : 50,
        "backgroundPositionY" : 50,
        "hideBackgroundGradient" : false,
        "hideLogoBackground" : false,
        "hideGroupName" : false
      },
      "storageConsumed" : 0,
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "mailKey" : null,
      "order" : null,
      "hash" : null,
      "components" : [ {
        "name" : "files",
        "order" : 0,
        "configuration" : { }
      }, {
        "name" : "pages",
        "order" : 1,
        "configuration" : { }
      }, {
        "name" : "events",
        "order" : 2,
        "configuration" : { }
      }, {
        "name" : "tasks",
        "order" : 3,
        "configuration" : { }
      } ],
      "masterConfiguration" : null,
      "blind" : false,
      "disableChat" : false,
      "disableComments" : false,
      "disableEmailComments" : false,
      "hideMemberDetails" : false,
      "disableAccordionWidgets" : true,
      "duplicate" : false,
      "watermarkConfiguration" : {
        "enableWatermark" : false,
        "enableWatermarkIp" : false,
        "enableWatermarkEmail" : false,
        "enableWatermarkTimestamp" : false,
        "enableWatermarkCustomText" : false,
        "watermarkCustomText" : null,
        "watermarkStyle" : null
      },
      "type" : "group",
      "account" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 393,
          "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
          "objectId" : 1
        },
        "creator" : {
          "id" : 1,
          "comments" : 0,
          "attachments" : 0,
          "contextKey" : {
            "id" : 48,
            "objectType" : "com.rabbitsoft.clinked.domain.User",
            "objectId" : 1
          },
          "username" : "jack",
          "enabled" : true,
          "locked" : false,
          "twoFactorAuthentication" : false,
          "lastModified" : 1514764800000,
          "lastLogin" : 1514764800000,
          "lastActive" : null,
          "dateCreated" : 1514764800000,
          "dateActivated" : 1514764800000,
          "name" : "Jack Bauer",
          "jobTitle" : "Marketing",
          "organisation" : "Clinked",
          "email" : "jack.bauer@clinked.com",
          "address" : "71 Pilgrim Avenue",
          "telephone" : "123456789",
          "other" : null,
          "logo" : false,
          "timeZone" : "Europe/Riga",
          "locale" : "en",
          "verifiedEmail" : false,
          "twoFactorMode" : null,
          "timeZoneOffset" : 180,
          "type" : "user"
        },
        "name" : "awesome_org",
        "friendlyName" : "Awesome Organisation",
        "dateCreated" : 1514764800000,
        "lastModified" : 1514764800000,
        "enabled" : true,
        "domain" : null,
        "mobileSchema" : null,
        "branding" : {
          "backgroundColor" : "#ffffff",
          "textColor" : "#ff0000",
          "logo" : false,
          "logoLarge" : false,
          "logoMedium" : false,
          "background" : false,
          "favicon" : false,
          "textLogo" : false,
          "gradient" : false,
          "gradientWidth" : 400
        },
        "samlConfiguration" : {
          "entityId" : null,
          "ssoEnabled" : false,
          "userJit" : true,
          "forceSso" : false,
          "adminsUsePassword" : true,
          "disableProfileEdit" : false,
          "forceAuth" : false
        },
        "hash" : null,
        "locale" : null,
        "type" : "account"
      }
    }
  }, {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 54,
      "objectType" : "com.rabbitsoft.clinked.domain.FileRecord",
      "objectId" : 1
    },
    "name" : "file_example.pdf",
    "friendlyName" : "File Example.pdf",
    "description" : null,
    "watermark" : false,
    "contentType" : "application/pdf",
    "size" : 1000,
    "uploaded" : {
      "user" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 250,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "Jack Bauer"
    },
    "versions" : 0,
    "sharing" : "NONE",
    "memberPermission" : 2,
    "hidden" : false,
    "tags" : "tag1,tag2",
    "locked" : false,
    "locker" : null,
    "dateLocked" : null,
    "lastModified" : 1514764800000,
    "previewInfo" : null,
    "inputStream" : null,
    "path" : [ ],
    "available" : true,
    "type" : "file",
    "parent" : null,
    "group" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 60,
        "objectType" : "com.rabbitsoft.clinked.domain.Space",
        "objectId" : 1
      },
      "master" : null,
      "owner" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 246,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "explore_clinked",
      "friendlyName" : "Explore Clinked",
      "members" : 0,
      "branding" : {
        "headerColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "background" : false,
        "alignment" : "left",
        "backgroundPositionX" : 50,
        "backgroundPositionY" : 50,
        "hideBackgroundGradient" : false,
        "hideLogoBackground" : false,
        "hideGroupName" : false
      },
      "storageConsumed" : 0,
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "mailKey" : null,
      "order" : null,
      "hash" : null,
      "components" : [ {
        "name" : "files",
        "order" : 0,
        "configuration" : { }
      }, {
        "name" : "pages",
        "order" : 1,
        "configuration" : { }
      }, {
        "name" : "events",
        "order" : 2,
        "configuration" : { }
      }, {
        "name" : "tasks",
        "order" : 3,
        "configuration" : { }
      } ],
      "masterConfiguration" : null,
      "blind" : false,
      "disableChat" : false,
      "disableComments" : false,
      "disableEmailComments" : false,
      "hideMemberDetails" : false,
      "disableAccordionWidgets" : true,
      "duplicate" : false,
      "watermarkConfiguration" : {
        "enableWatermark" : false,
        "enableWatermarkIp" : false,
        "enableWatermarkEmail" : false,
        "enableWatermarkTimestamp" : false,
        "enableWatermarkCustomText" : false,
        "watermarkCustomText" : null,
        "watermarkStyle" : null
      },
      "type" : "group",
      "account" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 740,
          "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
          "objectId" : 1
        },
        "creator" : {
          "id" : 1,
          "comments" : 0,
          "attachments" : 0,
          "contextKey" : {
            "id" : 207,
            "objectType" : "com.rabbitsoft.clinked.domain.User",
            "objectId" : 1
          },
          "username" : "jack",
          "enabled" : true,
          "locked" : false,
          "twoFactorAuthentication" : false,
          "lastModified" : 1514764800000,
          "lastLogin" : 1514764800000,
          "lastActive" : null,
          "dateCreated" : 1514764800000,
          "dateActivated" : 1514764800000,
          "name" : "Jack Bauer",
          "jobTitle" : "Marketing",
          "organisation" : "Clinked",
          "email" : "jack.bauer@clinked.com",
          "address" : "71 Pilgrim Avenue",
          "telephone" : "123456789",
          "other" : null,
          "logo" : false,
          "timeZone" : "Europe/Riga",
          "locale" : "en",
          "verifiedEmail" : false,
          "twoFactorMode" : null,
          "timeZoneOffset" : 180,
          "type" : "user"
        },
        "name" : "awesome_org",
        "friendlyName" : "Awesome Organisation",
        "dateCreated" : 1514764800000,
        "lastModified" : 1514764800000,
        "enabled" : true,
        "domain" : null,
        "mobileSchema" : null,
        "branding" : {
          "backgroundColor" : "#ffffff",
          "textColor" : "#ff0000",
          "logo" : false,
          "logoLarge" : false,
          "logoMedium" : false,
          "background" : false,
          "favicon" : false,
          "textLogo" : false,
          "gradient" : false,
          "gradientWidth" : 400
        },
        "samlConfiguration" : {
          "entityId" : null,
          "ssoEnabled" : false,
          "userJit" : true,
          "forceSso" : false,
          "adminsUsePassword" : true,
          "disableProfileEdit" : false,
          "forceAuth" : false
        },
        "hash" : null,
        "locale" : null,
        "type" : "account"
      }
    }
  } ]
}
Table 31. Definition of the returned fields
Path Type Description

currentPage

Number

Current page

pageSize

Number

Entries per page

nextPage

Boolean

Next page exists

page

Array

Page entries
Page entry fields are defined in Get a single file data.
Specific folder
Table 32. /v2/accounts/{organisation}/groups/{space}/files/{folder}/children
Parameter Description

organisation

Organisation/account id

space

Space/group id

folder

Folder id to get files from, empty for root directory
Example of a request
GET /v2/accounts/1/groups/1/files/1/children HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/1/children' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'

Result is the same as in Top level folder.

3.1.2. Get a single file data

Single file might contain more data about a file that is not present when retrieving a list.

Table 33. /v2/accounts/{organisation}/groups/{space}/files/{file}
Parameter Description

organisation

Organisation/account id

space

Space/group id

file

File id to retrieve
Example of a request
GET /v2/accounts/1/groups/1/files/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6433

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 594,
    "objectType" : "com.rabbitsoft.clinked.domain.FileRecord",
    "objectId" : 1
  },
  "name" : "file_example.pdf",
  "friendlyName" : "File Example.pdf",
  "description" : null,
  "watermark" : false,
  "contentType" : "application/pdf",
  "size" : 1000,
  "uploaded" : {
    "user" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 73,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "Jack Bauer"
  },
  "versions" : 0,
  "sharing" : "NONE",
  "memberPermission" : 2,
  "hidden" : false,
  "tags" : "tag1,tag2",
  "locked" : false,
  "locker" : null,
  "dateLocked" : null,
  "lastModified" : 1514764800000,
  "previewInfo" : null,
  "inputStream" : null,
  "path" : [ ],
  "available" : true,
  "type" : "file",
  "parent" : null,
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 428,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 208,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 953,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 829,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Table 34. Definition of the returned fields
Path Type Description

id

Number

File id

comments

Number

name

String

Unique file name, generated automatically by API

friendlyName

String

Full file name that should be visible to a user

contentType

String

Content type

description

String

Description of the content

size

Number

Size in bytes

uploaded

Object

User who uploaded a file

versions

Number

Number of versions

sharing

String

Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC]

memberPermission

Number

Member file permission mask

hidden

Boolean

Is hidden

tags

String

Tags separated by comma

watermark

Boolean

Shows watermarked preview if true

lastModified

Number

Last modification date (timestamp in milliseconds)

parent

Object

File parent folder

group

Object

A group to which file belongs to

3.1.3. Upload a file

Large files

This method allows to upload a file by small chunks and is preferred if a file is larger than 5 MiB. Also this method doesn’t create a file until a client informs the API about successful upload.

You can find the full code example here.
Chunk size has to be larger than 5 MiB (5242880 bytes). If a total file size is less than that, you need to use a different approach. See Small files section.
Table 35. /v2/accounts/{organisation}/groups/{space}/files/upload/data
Parameter Description

organisation

Organisation/account id

space

Space/group id
Table 36. Request headers
Name Description

X-File-Name

File full name

X-File-Type

File content type

X-File-Size

File full size

X-File-Chunk

Chunk index

X-File-Start

Chunk start

X-File-End

Chunk end
Example of a request (chunk #1)
POST /v2/accounts/1/groups/1/files/upload/data HTTP/1.1
X-File-Name: Lorem ipsum.txt
X-File-Type: text/plain
X-File-Size: 138
X-File-Chunk: 0
X-File-Start: 0
X-File-End: 67
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
Content-Length: 67

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed vitae.
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/upload/data' -i -X POST \
    -H 'X-File-Name: Lorem ipsum.txt' \
    -H 'X-File-Type: text/plain' \
    -H 'X-File-Size: 138' \
    -H 'X-File-Chunk: 0' \
    -H 'X-File-Start: 0' \
    -H 'X-File-End: 67' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -d 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed vitae.'
Example of a request (chunk #2)
POST /v2/accounts/1/groups/1/files/upload/data HTTP/1.1
X-File-Name: Lorem ipsum.txt
X-File-Type: text/plain
X-File-Size: 138
X-File-Chunk: 1
X-File-Start: 67
X-File-End: 138
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
Content-Length: 71

Nulla facilisi. Etiam dignissim libero id diam facilisis, vel volutpat.
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/upload/data' -i -X POST \
    -H 'X-File-Name: Lorem ipsum.txt' \
    -H 'X-File-Type: text/plain' \
    -H 'X-File-Size: 138' \
    -H 'X-File-Chunk: 1' \
    -H 'X-File-Start: 67' \
    -H 'X-File-End: 138' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -d 'Nulla facilisi. Etiam dignissim libero id diam facilisis, vel volutpat.'
Example of a success response
HTTP/1.1 200 OK

When all file chunks are uploaded a client should inform the API about successful upload, specify where to put the uploaded file and provide file metadata in the request body.

Table 37. Request headers
Name Description

X-File-Name

File full name

X-File-Type

File content type

X-File-Size

File full size
Table 38. Request parameters
Parameter Description

success

Mark upload as successful

forwardContext

Where to put successfully uploaded file in the following format: /v2/accounts/{organisation}/groups/{space}/files/{folder}. The {folder} parameter is optional, if it’s blank a file will be uploaded to the group top level folder.
Table 39. Request fields
Path Type Description

friendlyName

String

Full file name

contentType

String

File type

size

Number

File size

sharing

String

Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC]

memberPermission

Number

Member file permission mask
Example of a request
POST /v2/accounts/1/groups/1/files/upload/complete?success=true&forwardContext=%2Fv2%2Faccounts%2F1%2Fgroups%2F1%2Ffiles HTTP/1.1
Content-Type: application/json
X-File-Name: Lorem ipsum.txt
X-File-Type: text/plain
X-File-Size: 138
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
Content-Length: 139

{
  "memberPermission" : 8,
  "size" : 138,
  "sharing" : "MEMBERS",
  "contentType" : "text/plain",
  "friendlyName" : "Lorem ipsum.txt"
}
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/upload/complete?success=true&forwardContext=%2Fv2%2Faccounts%2F1%2Fgroups%2F1%2Ffiles' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'X-File-Name: Lorem ipsum.txt' \
    -H 'X-File-Type: text/plain' \
    -H 'X-File-Size: 138' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -d '{
  "memberPermission" : 8,
  "size" : 138,
  "sharing" : "MEMBERS",
  "contentType" : "text/plain",
  "friendlyName" : "Lorem ipsum.txt"
}'
Example of a success response
HTTP/1.1 200 OK
Small files
We encourage clients to upload files larger than 5 MiB (5242880 bytes) by chunks as described in the Large files section as it is more reliable method in most cases.

This method allows to upload small files (less than 100MB). If a file is larger than that please refer to Large files section.

There are 2 steps you need to do to upload a file using this method:

  1. Create a new File instance by providing information such as file size and type.

  2. Upload file contents with single request.

Create file instance

Before you upload a file you need to provide some data about it by creating a File instance.

Table 40. /v2/accounts/{organisation}/groups/{space}/files/{folder}
Parameter Description

organisation

Organisation/account id

space

Space/group id

folder

Optional. Folder id to create file in, empty for root directory
Table 41. Request fields
Path Type Description

friendlyName

String

Full file name

contentType

String

File content type

size

Number

File size

id

Number

Existing file id to update

sharing

String

Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC]

memberPermission

Number

Member file permission mask
Example of a request
POST /v2/accounts/1/groups/1/files/ HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Authorization:
Accept: application/json
Host: api.clinked.com
Content-Length: 145

{
  "memberPermission" : 8,
  "size" : 1000,
  "sharing" : "MEMBERS",
  "contentType" : "application/pdf",
  "friendlyName" : "My Document.pdf"
}
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Authorization: ' \
    -H 'Accept: application/json' \
    -d '{
  "memberPermission" : 8,
  "size" : 1000,
  "sharing" : "MEMBERS",
  "contentType" : "application/pdf",
  "friendlyName" : "My Document.pdf"
}'
Response fields are the same as defined in Get a single file data.
Upload file data
Table 42. /v2/accounts/{organisation}/groups/{space}/files/{file}/data
Parameter Description

organisation

Organisation/account id

space

Space/group id

file

File id
Example of a request
POST /v2/accounts/1/groups/1/files/1/data HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file

Lorem ipsum dolor sit amet, consectetur adipiscing elit. In fringilla.
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/1/data' -i -X POST \
    -H 'Content-Type: multipart/form-data' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -F 'file=Lorem ipsum dolor sit amet, consectetur adipiscing elit. In fringilla.'
Example of a success response
HTTP/1.1 200 OK

3.1.4. Create a folder

Table 43. /v2/accounts/{organisation}/groups/{space}/files/{folder}
Parameter Description

organisation

Organisation/account id

space

Space/group id

folder

Optional. Folder id to create folder in, empty for root directory
Table 44. Request fields
Path Type Description

friendlyName

String

Full folder name

contentType

String

Content type as '@folder'

size

Number

Size as '0'

id

Number

Existing folder id to update

sharing

String

Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC]

memberPermission

Number

Member file permission mask
Example of a request
POST /v2/accounts/1/groups/1/files/ HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 128

{
  "memberPermission" : 8,
  "size" : 0,
  "sharing" : "MEMBERS",
  "contentType" : "@folder",
  "friendlyName" : "My Folder"
}
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "memberPermission" : 8,
  "size" : 0,
  "sharing" : "MEMBERS",
  "contentType" : "@folder",
  "friendlyName" : "My Folder"
}'
Response fields are the same as defined in Get a single file data.

3.1.5. Remove a file

When removing a file it is placed to a group trash can and may be restored.

When removing a folder that contains files it is a client responsibility to recursively remove all files before removing a folder itself to avoid possible data loss because internal files are not automatically moved to a group trash can.
Table 45. /v2/accounts/{organisation}/groups/{space}/files/{file}
Parameter Description

organisation

Organisation/account id

space

Space/group id

file

File id to remove
Example of a request
DELETE /v2/accounts/1/groups/1/files/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/1' -i -X DELETE \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK

3.1.6. Move a file

Moves a file to other groups and folders.

Table 46. /v2/accounts/{organisation}/groups/{space}/files/{file}/move
Parameter Description

organisation

Organisation/account id

space

Space/group id

file

File id to move
Table 47. Request fields
Path Type Description

id

Number

Destination folder id, or null for group top level directory

group.id

Number

Destination group id
Example of a request
POST /v2/accounts/1/groups/1/files/1/move HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
Content-Length: 46

{
  "id" : 5,
  "group" : {
    "id" : 1
  }
}
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/1/move' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -d '{
  "id" : 5,
  "group" : {
    "id" : 1
  }
}'
Response fields are the same as defined in Get a single file data.

3.1.7. Download a file

Table 48. /v2/accounts/{organisation}/groups/{space}/files/{file}/download
Parameter Description

organisation

Organisation/account id

space

Space/group id

file

File id to download
Example of a request
GET /v2/accounts/1/groups/1/files/1/download HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/accounts/1/groups/1/files/1/download' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/pdf

3.2. Notes

API does not support note deletion yet.

3.2.1. List notes

View list of all organisation notes.

Table 49. /groups/{group}/pages
Parameter Description

group

Group name or @id
Table 50. Request parameters
Parameter Description

type

Type: page, template, dashboard

condition.name

Search by name

orderBy

Order field

ascending

Order ascending

currentPage

Page number to retrieve
Example of a request
GET /groups/@1/pages?type=page&orderBy=lastModified&ascending=false&currentPage=1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/pages?type=page&orderBy=lastModified&ascending=false&currentPage=1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6738

{
  "currentPage" : 1,
  "totalResults" : 1,
  "pageSize" : 1,
  "totalPages" : 1,
  "page" : [ {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 773,
      "objectType" : "com.rabbitsoft.clinked.domain.Page",
      "objectId" : 1
    },
    "name" : "home_page",
    "friendlyName" : "Home Page",
    "moved" : null,
    "template" : false,
    "tags" : "lorem,ipsum",
    "content" : "",
    "creator" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 22,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "sharing" : "MEMBERS",
    "memberPermission" : 8,
    "pageType" : "PAGE",
    "parent" : null,
    "type" : "page",
    "group" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 64,
        "objectType" : "com.rabbitsoft.clinked.domain.Space",
        "objectId" : 1
      },
      "master" : null,
      "owner" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 836,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "explore_clinked",
      "friendlyName" : "Explore Clinked",
      "members" : 0,
      "branding" : {
        "headerColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "background" : false,
        "alignment" : "left",
        "backgroundPositionX" : 50,
        "backgroundPositionY" : 50,
        "hideBackgroundGradient" : false,
        "hideLogoBackground" : false,
        "hideGroupName" : false
      },
      "storageConsumed" : 0,
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "mailKey" : null,
      "order" : null,
      "hash" : null,
      "components" : [ {
        "name" : "files",
        "order" : 0,
        "configuration" : { }
      }, {
        "name" : "pages",
        "order" : 1,
        "configuration" : { }
      }, {
        "name" : "events",
        "order" : 2,
        "configuration" : { }
      }, {
        "name" : "tasks",
        "order" : 3,
        "configuration" : { }
      } ],
      "masterConfiguration" : null,
      "blind" : false,
      "disableChat" : false,
      "disableComments" : false,
      "disableEmailComments" : false,
      "hideMemberDetails" : false,
      "disableAccordionWidgets" : true,
      "duplicate" : false,
      "watermarkConfiguration" : {
        "enableWatermark" : false,
        "enableWatermarkIp" : false,
        "enableWatermarkEmail" : false,
        "enableWatermarkTimestamp" : false,
        "enableWatermarkCustomText" : false,
        "watermarkCustomText" : null,
        "watermarkStyle" : null
      },
      "type" : "group",
      "account" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 181,
          "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
          "objectId" : 1
        },
        "creator" : {
          "id" : 1,
          "comments" : 0,
          "attachments" : 0,
          "contextKey" : {
            "id" : 57,
            "objectType" : "com.rabbitsoft.clinked.domain.User",
            "objectId" : 1
          },
          "username" : "jack",
          "enabled" : true,
          "locked" : false,
          "twoFactorAuthentication" : false,
          "lastModified" : 1514764800000,
          "lastLogin" : 1514764800000,
          "lastActive" : null,
          "dateCreated" : 1514764800000,
          "dateActivated" : 1514764800000,
          "name" : "Jack Bauer",
          "jobTitle" : "Marketing",
          "organisation" : "Clinked",
          "email" : "jack.bauer@clinked.com",
          "address" : "71 Pilgrim Avenue",
          "telephone" : "123456789",
          "other" : null,
          "logo" : false,
          "timeZone" : "Europe/Riga",
          "locale" : "en",
          "verifiedEmail" : false,
          "twoFactorMode" : null,
          "timeZoneOffset" : 180,
          "type" : "user"
        },
        "name" : "awesome_org",
        "friendlyName" : "Awesome Organisation",
        "dateCreated" : 1514764800000,
        "lastModified" : 1514764800000,
        "enabled" : true,
        "domain" : null,
        "mobileSchema" : null,
        "branding" : {
          "backgroundColor" : "#ffffff",
          "textColor" : "#ff0000",
          "logo" : false,
          "logoLarge" : false,
          "logoMedium" : false,
          "background" : false,
          "favicon" : false,
          "textLogo" : false,
          "gradient" : false,
          "gradientWidth" : 400
        },
        "samlConfiguration" : {
          "entityId" : null,
          "ssoEnabled" : false,
          "userJit" : true,
          "forceSso" : false,
          "adminsUsePassword" : true,
          "disableProfileEdit" : false,
          "forceAuth" : false
        },
        "hash" : null,
        "locale" : null,
        "type" : "account"
      }
    }
  } ],
  "nextPage" : false,
  "previousPage" : false
}
Table 51. Definition of the returned fields
Path Type Description

page

Array

Page items

nextPage

Boolean

Next page exists

previousPage

Boolean

Previous page exists

currentPage

Number

Current page number

pageSize

Number

Page size

totalPages

Number

Total amount of pages

totalResults

Number

Total amount of matching items

3.2.2. Get a single note data

View extended details for a single note.

Table 52. /groups/{group}/pages/{note}
Parameter Description

group

Group name or @id

note

Note name or @id
Example of a request
GET /groups/@1/pages/@1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/pages/@1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6531

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 97,
    "objectType" : "com.rabbitsoft.clinked.domain.PageWithContent",
    "objectId" : 1
  },
  "name" : "home_page",
  "friendlyName" : "Home Page",
  "moved" : null,
  "template" : false,
  "tags" : "lorem,ipsum",
  "content" : "<h2>Welcome to your Group Welcome Note!</h2><p><strong>This is a sample note to help you explore Clinked.</strong>",
  "creator" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 523,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "sharing" : "MEMBERS",
  "memberPermission" : 8,
  "pageType" : "PAGE",
  "parent" : null,
  "editContent" : "<h2>Welcome to your Group Welcome Note!</h2><p><strong>This is a sample note to help you explore Clinked.</strong>",
  "viewContent" : "<h2>Welcome to your Group Welcome Note!</h2><p><strong>This is a sample note to help you explore Clinked.</strong>",
  "type" : "page",
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 496,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 760,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 214,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 527,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Table 53. Definition of the returned fields
Path Type Description

id

Number

Id

comments

Number

Amount of comments

attachments

Number

Amount of attachments

name

String

Unique name

friendlyName

String

Full name

template

Boolean

Is a template

tags

String

Tags

content

String

Contents

creator

Object

Creator

dateCreated

Number

Creation date

lastModified

Number

Last modification date

sharing

String

Permission

memberPermission

Number

Permission mask

editContent

String

Content for editing

viewContent

String

Content for viewing

group

Object

Owner group

3.2.3. Create a note

Creates a new note for an organisation.

Table 54. /groups/{group}/pages
Parameter Description

group

Group name or @id
Table 55. Request fields
Path Type Description

friendlyName

String

Note name

content

String

Note content
Example of a request
POST /groups/@1/pages HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 64

{
  "friendlyName" : "Home page",
  "content" : "<p>Hello</p>"
}
$ curl 'https://api.clinked.com/groups/@1/pages' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "friendlyName" : "Home page",
  "content" : "<p>Hello</p>"
}'
Example of a success response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 5210

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : null,
  "name" : "home_page",
  "friendlyName" : "Home page",
  "moved" : null,
  "template" : false,
  "tags" : null,
  "content" : "",
  "creator" : null,
  "dateCreated" : null,
  "lastModified" : null,
  "sharing" : "MEMBERS",
  "memberPermission" : 8,
  "pageType" : "PAGE",
  "parent" : null,
  "editContent" : null,
  "viewContent" : null,
  "type" : "page",
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 755,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 829,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 950,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 407,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Response fields are defined in Get a single note data

3.2.4. Update a note

Changing note data and settings.

Table 56. /groups/{group}/pages/{note}
Parameter Description

group

Group name or @id

note

Note name or @id
Example of a request
POST /groups/@1/pages/@1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 64

{
  "friendlyName" : "Home page",
  "content" : "<p>Hello</p>"
}
$ curl 'https://api.clinked.com/groups/@1/pages/@1' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "friendlyName" : "Home page",
  "content" : "<p>Hello</p>"
}'
Example of a success response
HTTP/1.1 200 OK

3.2.5. Remove a note

Table 57. /groups/{group}/pages/{note}
Parameter Description

group

Group name or @id

note

Note name or @id
Example of a request
DELETE /groups/@1/pages/@1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/pages/@1' -i -X DELETE \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

3.3. Events

3.3.1. List events in date range

Retrieves all events in a date range.

Table 58. /groups/{group}/events/range
Parameter Description

group

Group name or @id
Table 59. Request parameters
Parameter Description

start

Range start date in ISO 8601

end

Range end date in ISO 8601
Example of a request
GET /groups/@1/events/range?start=2018-01-01T00%3A00%3A00Z&end=2018-02-01T00%3A00%3A00Z HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/events/range?start=2018-01-01T00%3A00%3A00Z&end=2018-02-01T00%3A00%3A00Z' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6434

[ {
  "id" : 1,
  "comments" : 5,
  "attachments" : 0,
  "contextKey" : {
    "id" : 508,
    "objectType" : "com.rabbitsoft.clinked.domain.Event",
    "objectId" : 1
  },
  "name" : "meeting_with_a_client",
  "friendlyName" : "Meeting with a client",
  "startDate" : 1515160800000,
  "endDate" : 1515164400000,
  "allDay" : false,
  "location" : "London",
  "tags" : "tag1,tag2",
  "description" : "Let's do this every friday",
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "dateReminder" : 1514707200000,
  "author" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 419,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "sharing" : "MEMBERS",
  "memberPermission" : 8,
  "attendees" : 5,
  "recurrence" : "FREQ=WEEKLY;WKST=MO;BYDAY=FR",
  "timeZone" : "Europe/Riga",
  "dateEndRecurrence" : 1684391968154,
  "disableMaybe" : false,
  "multiDay" : false,
  "type" : "event",
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 962,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 875,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 619,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 358,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
} ]
List item fields are defined in Get a single event data

3.3.2. Get a single event data

View extended details for a single event.

Table 60. /groups/{group}/events/{event}
Parameter Description

group

Group name or @id

event

Event name or @id
Example of a request
GET /groups/@1/events/@1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/events/@1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6526

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 709,
    "objectType" : "com.rabbitsoft.clinked.domain.Event",
    "objectId" : 1
  },
  "name" : "meeting_with_a_client",
  "friendlyName" : "Meeting with a client",
  "startDate" : 1515160800000,
  "endDate" : 1515164400000,
  "allDay" : false,
  "location" : "London",
  "tags" : "tag1,tag2",
  "description" : "Let's do this every friday",
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "dateReminder" : 1514707200000,
  "author" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 343,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "sharing" : "MEMBERS",
  "memberPermission" : 8,
  "attendees" : 5,
  "recurrence" : "FREQ=WEEKLY;WKST=MO;BYDAY=FR",
  "timeZone" : "Europe/Riga",
  "dateEndRecurrence" : 1684391968342,
  "disableMaybe" : false,
  "editContent" : "Let's do this every friday",
  "viewContent" : "Let's do this every friday",
  "type" : "event",
  "multiDay" : false,
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 976,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 155,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 627,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 810,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Table 61. Definition of the returned fields
Path Type Description

id

Number

Id

comments

Number

Amount of comments

attachments

Number

Amount of attachments

name

String

Unique name

friendlyName

String

Full name

startDate

Number

Start date and time

endDate

Number

End date and time

allDay

Boolean

Full day event

location

String

Location

tags

String

Tags

description

String

Description

editContent

String

Description optimized for editing

viewContent

String

Description optimized for viewing

dateCreated

Number

Creation date

lastModified

Number

Last modification date

dateReminder

Number

Remind date

author

Object

Creator

attendees

Number

Amount of attendees

recurrence

String

Recurrence rule (iCal)

dateEndRecurrence

Number

Recurrence end date

timeZone

String

Event time zone id

disableMaybe

Boolean

May attend attendee status is disabled

multiDay

Boolean

Is recurrent event

memberPermission

Number

Member permission

group

Object

Group

3.3.3. Create an event

Creates a new event.

Table 62. /groups/{group}/events
Parameter Description

group

Group name or @id
Table 63. Request fields
Path Type Description

friendlyName

String

Full name

description

String

Description

startDate

Number

Start date and time

endDate

Number

End date and time

allDay

Boolean

Is all day event

location

String

Location

dateReminder

Number

When to remind event attendees about the event via e-mail

recurrence

String

Recurrence rule (iCal)

dateEndRecurrence

Number

Recurrence end date

timeZone

String

Event time zone id

attendees

Array

List of usernames, e-mail addresses to assign to event. Only group members.

assignSelf

Boolean

Assign self to event
Example of a request
POST /groups/@1/events HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 335

{
  "recurrence" : "FREQ=WEEKLY;WKST=MO;BYDAY=FR",
  "allDay" : false,
  "dateReminder" : 1514707200000,
  "assignSelf" : true,
  "endDate" : 1515164400000,
  "description" : "Let's do this every friday",
  "timeZone" : "Europe/Riga",
  "location" : "London",
  "friendlyName" : "Meeting with a client",
  "startDate" : 1515160800000
}
$ curl 'https://api.clinked.com/groups/@1/events' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "recurrence" : "FREQ=WEEKLY;WKST=MO;BYDAY=FR",
  "allDay" : false,
  "dateReminder" : 1514707200000,
  "assignSelf" : true,
  "endDate" : 1515164400000,
  "description" : "Let's do this every friday",
  "timeZone" : "Europe/Riga",
  "location" : "London",
  "friendlyName" : "Meeting with a client",
  "startDate" : 1515160800000
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6413

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : null,
  "name" : "meeting_with_a_client",
  "friendlyName" : "Meeting with a client",
  "startDate" : 1515160800000,
  "endDate" : 1515164400000,
  "allDay" : false,
  "location" : "London",
  "tags" : "",
  "description" : "Let's do this every friday",
  "dateCreated" : 1684391968276,
  "lastModified" : 1684391968276,
  "dateReminder" : 1514707200000,
  "author" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 160,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "sharing" : "MEMBERS",
  "memberPermission" : 8,
  "attendees" : 0,
  "recurrence" : "FREQ=WEEKLY;WKST=MO;BYDAY=FR",
  "timeZone" : "Europe/Riga",
  "dateEndRecurrence" : null,
  "disableMaybe" : false,
  "editContent" : "Let's do this every friday",
  "viewContent" : "Let's do this every friday",
  "type" : "event",
  "multiDay" : false,
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 72,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 849,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 385,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 698,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Response fields are defined in Get a single event data

3.3.4. Update an event

Changing event data.

Table 64. /groups/{group}/events/{event}
Parameter Description

group

Group name or @id

event

Event name or @id
Example of a request
PUT /groups/@1/events/@1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 312

{
  "recurrence" : "FREQ=WEEKLY;WKST=MO;BYDAY=FR",
  "allDay" : false,
  "dateReminder" : 1514707200000,
  "endDate" : 1515164400000,
  "description" : "Let's do this every friday",
  "timeZone" : "Europe/Riga",
  "location" : "London",
  "friendlyName" : "Meeting with a client",
  "startDate" : 1515160800000
}
$ curl 'https://api.clinked.com/groups/@1/events/@1' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "recurrence" : "FREQ=WEEKLY;WKST=MO;BYDAY=FR",
  "allDay" : false,
  "dateReminder" : 1514707200000,
  "endDate" : 1515164400000,
  "description" : "Let's do this every friday",
  "timeZone" : "Europe/Riga",
  "location" : "London",
  "friendlyName" : "Meeting with a client",
  "startDate" : 1515160800000
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6517

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 217,
    "objectType" : "com.rabbitsoft.clinked.domain.Event",
    "objectId" : 1
  },
  "name" : "meeting_with_a_client",
  "friendlyName" : "Meeting with a client",
  "startDate" : 1515160800000,
  "endDate" : 1515164400000,
  "allDay" : false,
  "location" : "London",
  "tags" : "tag1,tag2",
  "description" : "Let's do this every friday",
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "dateReminder" : 1514707200000,
  "author" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 744,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "sharing" : "MEMBERS",
  "memberPermission" : 8,
  "attendees" : 5,
  "recurrence" : "FREQ=WEEKLY;WKST=MO;BYDAY=FR",
  "timeZone" : "Europe/Riga",
  "dateEndRecurrence" : null,
  "disableMaybe" : false,
  "editContent" : "Let's do this every friday",
  "viewContent" : "Let's do this every friday",
  "type" : "event",
  "multiDay" : false,
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 319,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 864,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 115,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 221,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6517

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 217,
    "objectType" : "com.rabbitsoft.clinked.domain.Event",
    "objectId" : 1
  },
  "name" : "meeting_with_a_client",
  "friendlyName" : "Meeting with a client",
  "startDate" : 1515160800000,
  "endDate" : 1515164400000,
  "allDay" : false,
  "location" : "London",
  "tags" : "tag1,tag2",
  "description" : "Let's do this every friday",
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "dateReminder" : 1514707200000,
  "author" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 744,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "sharing" : "MEMBERS",
  "memberPermission" : 8,
  "attendees" : 5,
  "recurrence" : "FREQ=WEEKLY;WKST=MO;BYDAY=FR",
  "timeZone" : "Europe/Riga",
  "dateEndRecurrence" : null,
  "disableMaybe" : false,
  "editContent" : "Let's do this every friday",
  "viewContent" : "Let's do this every friday",
  "type" : "event",
  "multiDay" : false,
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 319,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 864,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 115,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 221,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Response fields are defined in Get a single event data

3.3.5. Delete an event

Deleting event.

Table 65. /groups/{group}/events/{event}
Parameter Description

group

Group name or @id

event

Event name or @id
Example of a request
DELETE /groups/@1/events/@1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/events/@1' -i -X DELETE \
    -H 'Authorization: Bearer <YOUR-TOKEN>'
Example of a success response
HTTP/1.1 200 OK

3.4. Tasks

3.4.1. List tasks

Retrieves all tasks in a date range.

Table 66. /groups/{group}/tasks
Parameter Description

group

Group name or @id
Table 67. Request parameters
Parameter Description

completed

Include completed tasks

orderBy

Order field

ascending

Order ascending

currentPage

Page number to retrieve
Example of a request
GET /groups/@1/tasks?completed=true&orderBy=dateCreated&ascending=false&currentPage=1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/tasks?completed=true&orderBy=dateCreated&ascending=false&currentPage=1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 7116

{
  "currentPage" : 1,
  "totalResults" : 1,
  "pageSize" : 1,
  "totalPages" : 1,
  "page" : [ {
    "id" : 1,
    "comments" : 5,
    "attachments" : 0,
    "contextKey" : {
      "id" : 383,
      "objectType" : "com.rabbitsoft.clinked.domain.Task",
      "objectId" : 1
    },
    "category" : null,
    "name" : "deploy_update",
    "friendlyName" : "Deploy update",
    "status" : "NOT_STARTED",
    "progress" : 0,
    "datePriority" : 2,
    "dueDate" : 1661428614000,
    "tags" : "",
    "description" : "Let's do this",
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "dateReminder" : 1514707200000,
    "author" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 332,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "sharing" : "MEMBERS",
    "memberPermission" : 8,
    "recurrence" : null,
    "recurId" : null,
    "timeZone" : null,
    "order" : 2147483647,
    "priority" : "MEDIUM",
    "parent" : null,
    "timeTracker" : null,
    "overdue" : true,
    "summary" : "explore_clinked: Deploy update",
    "timeSet" : true,
    "completed" : false,
    "type" : "task",
    "group" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 818,
        "objectType" : "com.rabbitsoft.clinked.domain.Space",
        "objectId" : 1
      },
      "master" : null,
      "owner" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 152,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "explore_clinked",
      "friendlyName" : "Explore Clinked",
      "members" : 0,
      "branding" : {
        "headerColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "background" : false,
        "alignment" : "left",
        "backgroundPositionX" : 50,
        "backgroundPositionY" : 50,
        "hideBackgroundGradient" : false,
        "hideLogoBackground" : false,
        "hideGroupName" : false
      },
      "storageConsumed" : 0,
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "mailKey" : null,
      "order" : null,
      "hash" : null,
      "components" : [ {
        "name" : "files",
        "order" : 0,
        "configuration" : { }
      }, {
        "name" : "pages",
        "order" : 1,
        "configuration" : { }
      }, {
        "name" : "events",
        "order" : 2,
        "configuration" : { }
      }, {
        "name" : "tasks",
        "order" : 3,
        "configuration" : { }
      } ],
      "masterConfiguration" : null,
      "blind" : false,
      "disableChat" : false,
      "disableComments" : false,
      "disableEmailComments" : false,
      "hideMemberDetails" : false,
      "disableAccordionWidgets" : true,
      "duplicate" : false,
      "watermarkConfiguration" : {
        "enableWatermark" : false,
        "enableWatermarkIp" : false,
        "enableWatermarkEmail" : false,
        "enableWatermarkTimestamp" : false,
        "enableWatermarkCustomText" : false,
        "watermarkCustomText" : null,
        "watermarkStyle" : null
      },
      "type" : "group",
      "account" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 64,
          "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
          "objectId" : 1
        },
        "creator" : {
          "id" : 1,
          "comments" : 0,
          "attachments" : 0,
          "contextKey" : {
            "id" : 921,
            "objectType" : "com.rabbitsoft.clinked.domain.User",
            "objectId" : 1
          },
          "username" : "jack",
          "enabled" : true,
          "locked" : false,
          "twoFactorAuthentication" : false,
          "lastModified" : 1514764800000,
          "lastLogin" : 1514764800000,
          "lastActive" : null,
          "dateCreated" : 1514764800000,
          "dateActivated" : 1514764800000,
          "name" : "Jack Bauer",
          "jobTitle" : "Marketing",
          "organisation" : "Clinked",
          "email" : "jack.bauer@clinked.com",
          "address" : "71 Pilgrim Avenue",
          "telephone" : "123456789",
          "other" : null,
          "logo" : false,
          "timeZone" : "Europe/Riga",
          "locale" : "en",
          "verifiedEmail" : false,
          "twoFactorMode" : null,
          "timeZoneOffset" : 180,
          "type" : "user"
        },
        "name" : "awesome_org",
        "friendlyName" : "Awesome Organisation",
        "dateCreated" : 1514764800000,
        "lastModified" : 1514764800000,
        "enabled" : true,
        "domain" : null,
        "mobileSchema" : null,
        "branding" : {
          "backgroundColor" : "#ffffff",
          "textColor" : "#ff0000",
          "logo" : false,
          "logoLarge" : false,
          "logoMedium" : false,
          "background" : false,
          "favicon" : false,
          "textLogo" : false,
          "gradient" : false,
          "gradientWidth" : 400
        },
        "samlConfiguration" : {
          "entityId" : null,
          "ssoEnabled" : false,
          "userJit" : true,
          "forceSso" : false,
          "adminsUsePassword" : true,
          "disableProfileEdit" : false,
          "forceAuth" : false
        },
        "hash" : null,
        "locale" : null,
        "type" : "account"
      }
    }
  } ],
  "nextPage" : false,
  "previousPage" : false
}
List item fields are defined in Get a single task data

3.4.2. Get a single task data

View extended details for a single task.

Table 68. /groups/{group}/tasks/{task}
Parameter Description

group

Group name or @id

task

Task name or @id
Example of a request
GET /groups/@1/tasks/@1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/tasks/@1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6555

{
  "id" : 1,
  "comments" : 5,
  "attachments" : 0,
  "contextKey" : {
    "id" : 905,
    "objectType" : "com.rabbitsoft.clinked.domain.Task",
    "objectId" : 1
  },
  "category" : null,
  "name" : "deploy_update",
  "friendlyName" : "Deploy update",
  "status" : "NOT_STARTED",
  "progress" : 0,
  "datePriority" : 2,
  "dueDate" : 1661428614000,
  "tags" : "",
  "description" : "Let's do this",
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "dateReminder" : 1514707200000,
  "author" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 745,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "sharing" : "MEMBERS",
  "memberPermission" : 8,
  "recurrence" : null,
  "recurId" : null,
  "timeZone" : null,
  "order" : 2147483647,
  "priority" : "MEDIUM",
  "parent" : null,
  "timeTracker" : null,
  "editContent" : "Let's do this",
  "viewContent" : "Let's do this",
  "type" : "task",
  "overdue" : true,
  "summary" : "explore_clinked: Deploy update",
  "timeSet" : true,
  "completed" : false,
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 143,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 230,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 941,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 602,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Table 69. Definition of the returned fields
Path Type Description

id

Number

Id

comments

Number

Amount of comments

attachments

Number

Amount of attachments

name

String

Unique name

friendlyName

String

Full name

status

String

Status

priority

String

Priority

progress

Number

Progress in %

datePriority

Number

Priority

tags

String

Tags

description

String

Description

editContent

String

Description optimized for editing

viewContent

String

Description for viewing

dateCreated

Number

Creation date

lastModified

Number

Last modification date

dateReminder

Number

Reminder date

author

Object

Creator

timeZone

String

Task time zone id

timeSet

Boolean

Is time set

completed

Boolean

Is completed

overdue

Boolean

Is task overdue

summary

String

Summary text

group

Object

Owner group

category

Object

Task category

order

Number

Task order from smallest to largest

3.4.3. Create a task

Creates a new task.

Table 70. /groups/{group}/tasks
Parameter Description

group

Group name or @id
Table 71. Request fields
Path Type Description

friendlyName

String

Full name

description

String

Description

status

String

Status: [NOT_STARTED, IN_PROGRESS, DEFERRED, WAITING, COMPLETED]

dateReminder

Number

Reminder date

dueDate

Number

Deadline

assignees

Array

List of usernames, e-mail addresses to assign to task. Only group members.

assignSelf

Boolean

Assign self to task

progress

Number

Completion progress in %
Example of a request
POST /groups/@1/tasks HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 184

{
  "dateReminder" : 1684391964906,
  "dueDate" : 1684391964906,
  "description" : "Do this",
  "progress" : 50,
  "friendlyName" : "Deploy latest update",
  "status" : "IN_PROGRESS"
}
$ curl 'https://api.clinked.com/groups/@1/tasks' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "dateReminder" : 1684391964906,
  "dueDate" : 1684391964906,
  "description" : "Do this",
  "progress" : 50,
  "friendlyName" : "Deploy latest update",
  "status" : "IN_PROGRESS"
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6476

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : null,
  "category" : null,
  "name" : "deploy_latest_update",
  "friendlyName" : "Deploy latest update",
  "status" : "IN_PROGRESS",
  "progress" : 50,
  "datePriority" : 2,
  "dueDate" : 1684391964906,
  "tags" : "",
  "description" : "Do this",
  "dateCreated" : 1684391965058,
  "lastModified" : 1684391965058,
  "dateReminder" : 1684391964906,
  "author" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 748,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "sharing" : "MEMBERS",
  "memberPermission" : 8,
  "recurrence" : null,
  "recurId" : null,
  "timeZone" : "Europe/London",
  "order" : 2147483647,
  "priority" : "MEDIUM",
  "parent" : null,
  "timeTracker" : null,
  "editContent" : "Do this",
  "viewContent" : "Do this",
  "type" : "task",
  "overdue" : true,
  "summary" : "explore_clinked: Deploy latest update",
  "timeSet" : true,
  "completed" : false,
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 744,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 953,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 893,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 57,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Response fields are defined in Get a single task data

3.4.4. Update a task

Changing task data.

Table 72. /groups/{group}/tasks/{task}
Parameter Description

group

Group name or @id

task

Task name or @id

3.5. Discussions

3.5.1. List discussions

Table 73. /groups/{group}/discussions
Parameter Description

group

Group name or @id
Example of a request
GET /groups/@1/discussions HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/discussions' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6854

{
  "currentPage" : 1,
  "totalResults" : 1,
  "pageSize" : 1,
  "totalPages" : 1,
  "page" : [ {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 798,
      "objectType" : "com.rabbitsoft.clinked.domain.Discussion",
      "objectId" : 1
    },
    "name" : "great_discussion",
    "friendlyName" : "Great discussion",
    "tags" : "",
    "description" : "What do you think about this?",
    "replies" : 5,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "sharing" : "MEMBERS",
    "memberPermission" : 2,
    "author" : {
      "user" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 402,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "Jack Bauer"
    },
    "replier" : null,
    "type" : "discussion",
    "group" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 52,
        "objectType" : "com.rabbitsoft.clinked.domain.Space",
        "objectId" : 1
      },
      "master" : null,
      "owner" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 762,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "explore_clinked",
      "friendlyName" : "Explore Clinked",
      "members" : 0,
      "branding" : {
        "headerColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "background" : false,
        "alignment" : "left",
        "backgroundPositionX" : 50,
        "backgroundPositionY" : 50,
        "hideBackgroundGradient" : false,
        "hideLogoBackground" : false,
        "hideGroupName" : false
      },
      "storageConsumed" : 0,
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "mailKey" : null,
      "order" : null,
      "hash" : null,
      "components" : [ {
        "name" : "files",
        "order" : 0,
        "configuration" : { }
      }, {
        "name" : "pages",
        "order" : 1,
        "configuration" : { }
      }, {
        "name" : "events",
        "order" : 2,
        "configuration" : { }
      }, {
        "name" : "tasks",
        "order" : 3,
        "configuration" : { }
      } ],
      "masterConfiguration" : null,
      "blind" : false,
      "disableChat" : false,
      "disableComments" : false,
      "disableEmailComments" : false,
      "hideMemberDetails" : false,
      "disableAccordionWidgets" : true,
      "duplicate" : false,
      "watermarkConfiguration" : {
        "enableWatermark" : false,
        "enableWatermarkIp" : false,
        "enableWatermarkEmail" : false,
        "enableWatermarkTimestamp" : false,
        "enableWatermarkCustomText" : false,
        "watermarkCustomText" : null,
        "watermarkStyle" : null
      },
      "type" : "group",
      "account" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 775,
          "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
          "objectId" : 1
        },
        "creator" : {
          "id" : 1,
          "comments" : 0,
          "attachments" : 0,
          "contextKey" : {
            "id" : 858,
            "objectType" : "com.rabbitsoft.clinked.domain.User",
            "objectId" : 1
          },
          "username" : "jack",
          "enabled" : true,
          "locked" : false,
          "twoFactorAuthentication" : false,
          "lastModified" : 1514764800000,
          "lastLogin" : 1514764800000,
          "lastActive" : null,
          "dateCreated" : 1514764800000,
          "dateActivated" : 1514764800000,
          "name" : "Jack Bauer",
          "jobTitle" : "Marketing",
          "organisation" : "Clinked",
          "email" : "jack.bauer@clinked.com",
          "address" : "71 Pilgrim Avenue",
          "telephone" : "123456789",
          "other" : null,
          "logo" : false,
          "timeZone" : "Europe/Riga",
          "locale" : "en",
          "verifiedEmail" : false,
          "twoFactorMode" : null,
          "timeZoneOffset" : 180,
          "type" : "user"
        },
        "name" : "awesome_org",
        "friendlyName" : "Awesome Organisation",
        "dateCreated" : 1514764800000,
        "lastModified" : 1514764800000,
        "enabled" : true,
        "domain" : null,
        "mobileSchema" : null,
        "branding" : {
          "backgroundColor" : "#ffffff",
          "textColor" : "#ff0000",
          "logo" : false,
          "logoLarge" : false,
          "logoMedium" : false,
          "background" : false,
          "favicon" : false,
          "textLogo" : false,
          "gradient" : false,
          "gradientWidth" : 400
        },
        "samlConfiguration" : {
          "entityId" : null,
          "ssoEnabled" : false,
          "userJit" : true,
          "forceSso" : false,
          "adminsUsePassword" : true,
          "disableProfileEdit" : false,
          "forceAuth" : false
        },
        "hash" : null,
        "locale" : null,
        "type" : "account"
      }
    }
  } ],
  "nextPage" : false,
  "previousPage" : false
}
Table 74. Definition of the returned fields
Path Type Description

page

Array

Page items

nextPage

Boolean

Next page exists

previousPage

Boolean

Previous page exists

currentPage

Number

Current page number

pageSize

Number

Page size

totalPages

Number

Total amount of pages

totalResults

Number

Total amount of matching items

3.5.2. Get a single discussion

Table 75. /groups/{group}/discussions/{discussion}
Parameter Description

group

Group name or @id

discussion

Discussion name or @id
Example of a request
GET /groups/@1/discussions/@1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/discussions/@1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6348

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 811,
    "objectType" : "com.rabbitsoft.clinked.domain.Discussion",
    "objectId" : 1
  },
  "name" : "great_discussion",
  "friendlyName" : "Great discussion",
  "tags" : "",
  "description" : "What do you think about this?",
  "replies" : 5,
  "dateCreated" : 1514764800000,
  "lastModified" : 1514764800000,
  "sharing" : "MEMBERS",
  "memberPermission" : 2,
  "author" : {
    "user" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 238,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "Jack Bauer"
  },
  "replier" : null,
  "editContent" : "What do you think about this?",
  "viewContent" : "What do you think about this?",
  "type" : "discussion",
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 208,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 801,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 18,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 822,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Table 76. Definition of the returned fields
Path Type Description

id

Number

Id

replies

Number

Amount of replies

dateCreated

Number

Creation date

lastModified

Number

Last modification date

author

Object

Author

memberPermission

Number

Member permission

group

Object

Group

name

String

Unique name

friendlyName

String

Full name

tags

String

Tags

description

String

Description

editContent

String

Description optimized for editing

viewContent

String

Description optimized for viewing

sharing

String

Permission

3.5.3. Create a discussion

Table 77. /groups/{group}/discussions
Parameter Description

group

Group name or @id
Table 78. Request fields
Path Type Description

friendlyName

String

Name

description

String

Description
Example of a request
POST /groups/@1/discussions HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 77

{
  "description" : "What do you think?",
  "friendlyName" : "Discuss this"
}
$ curl 'https://api.clinked.com/groups/@1/discussions' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "description" : "What do you think?",
  "friendlyName" : "Discuss this"
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 6207

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : null,
  "name" : "discuss_this",
  "friendlyName" : "Discuss this",
  "tags" : "",
  "description" : "What do you think?",
  "replies" : 0,
  "dateCreated" : 1684391966432,
  "lastModified" : 1684391966432,
  "sharing" : "MEMBERS",
  "memberPermission" : 2,
  "author" : {
    "user" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 58,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "Jack Bauer"
  },
  "replier" : null,
  "editContent" : "What do you think?",
  "viewContent" : "What do you think?",
  "type" : "discussion",
  "group" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 644,
      "objectType" : "com.rabbitsoft.clinked.domain.Space",
      "objectId" : 1
    },
    "master" : null,
    "owner" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 69,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "explore_clinked",
    "friendlyName" : "Explore Clinked",
    "members" : 0,
    "branding" : {
      "headerColor" : "#ffffff",
      "textColor" : "#ff0000",
      "logo" : false,
      "background" : false,
      "alignment" : "left",
      "backgroundPositionX" : 50,
      "backgroundPositionY" : 50,
      "hideBackgroundGradient" : false,
      "hideLogoBackground" : false,
      "hideGroupName" : false
    },
    "storageConsumed" : 0,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "mailKey" : null,
    "order" : null,
    "hash" : null,
    "components" : [ {
      "name" : "files",
      "order" : 0,
      "configuration" : { }
    }, {
      "name" : "pages",
      "order" : 1,
      "configuration" : { }
    }, {
      "name" : "events",
      "order" : 2,
      "configuration" : { }
    }, {
      "name" : "tasks",
      "order" : 3,
      "configuration" : { }
    } ],
    "masterConfiguration" : null,
    "blind" : false,
    "disableChat" : false,
    "disableComments" : false,
    "disableEmailComments" : false,
    "hideMemberDetails" : false,
    "disableAccordionWidgets" : true,
    "duplicate" : false,
    "watermarkConfiguration" : {
      "enableWatermark" : false,
      "enableWatermarkIp" : false,
      "enableWatermarkEmail" : false,
      "enableWatermarkTimestamp" : false,
      "enableWatermarkCustomText" : false,
      "watermarkCustomText" : null,
      "watermarkStyle" : null
    },
    "type" : "group",
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 708,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 217,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    }
  }
}
Table 79. Definition of the returned fields
Path Type Description

id

Number

Id

replies

Number

Amount of replies

dateCreated

Number

Creation date

lastModified

Number

Last modification date

author

Object

Author

memberPermission

Number

Member permission

group

Object

Group

name

String

Unique name

friendlyName

String

Full name

tags

String

Tags

description

String

Description

editContent

String

Description optimized for editing

viewContent

String

Description optimized for viewing

sharing

String

Permission

3.5.4. List discussion replies

Table 80. /groups/{group}/discussions/{discussion}/replies
Parameter Description

group

Group name or @id

discussion

Discussion name or @id
Example of a request
GET /groups/@1/discussions/@1/replies HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/discussions/@1/replies' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 7896

[ {
  "id" : 1,
  "discussion" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 401,
      "objectType" : "com.rabbitsoft.clinked.domain.Discussion",
      "objectId" : 1
    },
    "name" : "great_discussion",
    "friendlyName" : "Great discussion",
    "tags" : "",
    "description" : "What do you think about this?",
    "replies" : 5,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "sharing" : "MEMBERS",
    "memberPermission" : 2,
    "author" : {
      "user" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 828,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "Jack Bauer"
    },
    "replier" : null,
    "type" : "discussion",
    "group" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 435,
        "objectType" : "com.rabbitsoft.clinked.domain.Space",
        "objectId" : 1
      },
      "master" : null,
      "owner" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 594,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "explore_clinked",
      "friendlyName" : "Explore Clinked",
      "members" : 0,
      "branding" : {
        "headerColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "background" : false,
        "alignment" : "left",
        "backgroundPositionX" : 50,
        "backgroundPositionY" : 50,
        "hideBackgroundGradient" : false,
        "hideLogoBackground" : false,
        "hideGroupName" : false
      },
      "storageConsumed" : 0,
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "mailKey" : null,
      "order" : null,
      "hash" : null,
      "components" : [ {
        "name" : "files",
        "order" : 0,
        "configuration" : { }
      }, {
        "name" : "pages",
        "order" : 1,
        "configuration" : { }
      }, {
        "name" : "events",
        "order" : 2,
        "configuration" : { }
      }, {
        "name" : "tasks",
        "order" : 3,
        "configuration" : { }
      } ],
      "masterConfiguration" : null,
      "blind" : false,
      "disableChat" : false,
      "disableComments" : false,
      "disableEmailComments" : false,
      "hideMemberDetails" : false,
      "disableAccordionWidgets" : true,
      "duplicate" : false,
      "watermarkConfiguration" : {
        "enableWatermark" : false,
        "enableWatermarkIp" : false,
        "enableWatermarkEmail" : false,
        "enableWatermarkTimestamp" : false,
        "enableWatermarkCustomText" : false,
        "watermarkCustomText" : null,
        "watermarkStyle" : null
      },
      "type" : "group",
      "account" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 974,
          "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
          "objectId" : 1
        },
        "creator" : {
          "id" : 1,
          "comments" : 0,
          "attachments" : 0,
          "contextKey" : {
            "id" : 768,
            "objectType" : "com.rabbitsoft.clinked.domain.User",
            "objectId" : 1
          },
          "username" : "jack",
          "enabled" : true,
          "locked" : false,
          "twoFactorAuthentication" : false,
          "lastModified" : 1514764800000,
          "lastLogin" : 1514764800000,
          "lastActive" : null,
          "dateCreated" : 1514764800000,
          "dateActivated" : 1514764800000,
          "name" : "Jack Bauer",
          "jobTitle" : "Marketing",
          "organisation" : "Clinked",
          "email" : "jack.bauer@clinked.com",
          "address" : "71 Pilgrim Avenue",
          "telephone" : "123456789",
          "other" : null,
          "logo" : false,
          "timeZone" : "Europe/Riga",
          "locale" : "en",
          "verifiedEmail" : false,
          "twoFactorMode" : null,
          "timeZoneOffset" : 180,
          "type" : "user"
        },
        "name" : "awesome_org",
        "friendlyName" : "Awesome Organisation",
        "dateCreated" : 1514764800000,
        "lastModified" : 1514764800000,
        "enabled" : true,
        "domain" : null,
        "mobileSchema" : null,
        "branding" : {
          "backgroundColor" : "#ffffff",
          "textColor" : "#ff0000",
          "logo" : false,
          "logoLarge" : false,
          "logoMedium" : false,
          "background" : false,
          "favicon" : false,
          "textLogo" : false,
          "gradient" : false,
          "gradientWidth" : 400
        },
        "samlConfiguration" : {
          "entityId" : null,
          "ssoEnabled" : false,
          "userJit" : true,
          "forceSso" : false,
          "adminsUsePassword" : true,
          "disableProfileEdit" : false,
          "forceAuth" : false
        },
        "hash" : null,
        "locale" : null,
        "type" : "account"
      }
    }
  },
  "author" : {
    "user" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 449,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "Jack Bauer"
  },
  "reply" : "Here are my 2 cents",
  "dateCreated" : 1514764800000,
  "silent" : false,
  "editContent" : "Here are my 2 cents",
  "viewContent" : "Here are my 2 cents"
} ]
Table 81. Definition of the returned fields
Path Type Description

[].id

Number

Id

[].discussion

Object

Discussion

[].author

Object

Author

[].reply

String

Reply text

[].dateCreated

Number

Creation date

[].editContent

String

Reply text for editing

[].viewContent

String

Reply text optimized for viewing

3.5.5. Create discussion reply

Table 82. /groups/{group}/discussions/{discussion}/replies
Parameter Description

group

Group name or @id

discussion

Discussion name or @id
Table 83. Request fields
Path Type Description

reply

String

Reply text
Example of a request
POST /groups/@1/discussions/@1/replies HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 37

{
  "reply" : "Here are my 2 cents"
}
$ curl 'https://api.clinked.com/groups/@1/discussions/@1/replies' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "reply" : "Here are my 2 cents"
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 7891

{
  "id" : 1,
  "discussion" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 705,
      "objectType" : "com.rabbitsoft.clinked.domain.Discussion",
      "objectId" : 1
    },
    "name" : "great_discussion",
    "friendlyName" : "Great discussion",
    "tags" : "",
    "description" : "What do you think about this?",
    "replies" : 5,
    "dateCreated" : 1514764800000,
    "lastModified" : 1514764800000,
    "sharing" : "MEMBERS",
    "memberPermission" : 2,
    "author" : {
      "user" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 588,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "Jack Bauer"
    },
    "replier" : null,
    "type" : "discussion",
    "group" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 822,
        "objectType" : "com.rabbitsoft.clinked.domain.Space",
        "objectId" : 1
      },
      "master" : null,
      "owner" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 951,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "explore_clinked",
      "friendlyName" : "Explore Clinked",
      "members" : 0,
      "branding" : {
        "headerColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "background" : false,
        "alignment" : "left",
        "backgroundPositionX" : 50,
        "backgroundPositionY" : 50,
        "hideBackgroundGradient" : false,
        "hideLogoBackground" : false,
        "hideGroupName" : false
      },
      "storageConsumed" : 0,
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "mailKey" : null,
      "order" : null,
      "hash" : null,
      "components" : [ {
        "name" : "files",
        "order" : 0,
        "configuration" : { }
      }, {
        "name" : "pages",
        "order" : 1,
        "configuration" : { }
      }, {
        "name" : "events",
        "order" : 2,
        "configuration" : { }
      }, {
        "name" : "tasks",
        "order" : 3,
        "configuration" : { }
      } ],
      "masterConfiguration" : null,
      "blind" : false,
      "disableChat" : false,
      "disableComments" : false,
      "disableEmailComments" : false,
      "hideMemberDetails" : false,
      "disableAccordionWidgets" : true,
      "duplicate" : false,
      "watermarkConfiguration" : {
        "enableWatermark" : false,
        "enableWatermarkIp" : false,
        "enableWatermarkEmail" : false,
        "enableWatermarkTimestamp" : false,
        "enableWatermarkCustomText" : false,
        "watermarkCustomText" : null,
        "watermarkStyle" : null
      },
      "type" : "group",
      "account" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 887,
          "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
          "objectId" : 1
        },
        "creator" : {
          "id" : 1,
          "comments" : 0,
          "attachments" : 0,
          "contextKey" : {
            "id" : 293,
            "objectType" : "com.rabbitsoft.clinked.domain.User",
            "objectId" : 1
          },
          "username" : "jack",
          "enabled" : true,
          "locked" : false,
          "twoFactorAuthentication" : false,
          "lastModified" : 1514764800000,
          "lastLogin" : 1514764800000,
          "lastActive" : null,
          "dateCreated" : 1514764800000,
          "dateActivated" : 1514764800000,
          "name" : "Jack Bauer",
          "jobTitle" : "Marketing",
          "organisation" : "Clinked",
          "email" : "jack.bauer@clinked.com",
          "address" : "71 Pilgrim Avenue",
          "telephone" : "123456789",
          "other" : null,
          "logo" : false,
          "timeZone" : "Europe/Riga",
          "locale" : "en",
          "verifiedEmail" : false,
          "twoFactorMode" : null,
          "timeZoneOffset" : 180,
          "type" : "user"
        },
        "name" : "awesome_org",
        "friendlyName" : "Awesome Organisation",
        "dateCreated" : 1514764800000,
        "lastModified" : 1514764800000,
        "enabled" : true,
        "domain" : null,
        "mobileSchema" : null,
        "branding" : {
          "backgroundColor" : "#ffffff",
          "textColor" : "#ff0000",
          "logo" : false,
          "logoLarge" : false,
          "logoMedium" : false,
          "background" : false,
          "favicon" : false,
          "textLogo" : false,
          "gradient" : false,
          "gradientWidth" : 400
        },
        "samlConfiguration" : {
          "entityId" : null,
          "ssoEnabled" : false,
          "userJit" : true,
          "forceSso" : false,
          "adminsUsePassword" : true,
          "disableProfileEdit" : false,
          "forceAuth" : false
        },
        "hash" : null,
        "locale" : null,
        "type" : "account"
      }
    }
  },
  "author" : {
    "user" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 82,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "name" : "Jack Bauer"
  },
  "reply" : "Here are my 2 cents",
  "dateCreated" : 1684391966143,
  "silent" : false,
  "editContent" : "Here are my 2 cents",
  "viewContent" : "Here are my 2 cents"
}
Table 84. Definition of the returned fields
Path Type Description

id

Number

Id

discussion

Object

Discussion

author

Object

Author

reply

String

Reply text

editContent

String

Reply text optimized for editing

viewContent

String

Reply text optimized for viewing

dateCreated

Number

Creation date

3.5.6. Delete discussion reply

Table 85. /groups/{group}/discussions/{discussion}/replies/@{reply}
Parameter Description

group

Group name or @id

discussion

Discussion name or @id

reply

Reply id
Example of a request
DELETE /groups/@1/discussions/@1/replies/@1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups/@1/discussions/@1/replies/@1' -i -X DELETE \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK

3.6. Activity

Activity is a list of events called "updates". Each update has a type that should be mapped to a template which is populated by additional data. Example template:

{0} uploaded file {3} in {2}

A template can contain one of the following placeholders:

Placeholder number Data

0

Username

1

Organisation name

2

Group name

3

Component name

4

Target username

5

Reserved name

For a list of all type → template mappings see Appendix D: Update templates.

3.6.1. List group updates

Retrieves a list of of group updates. Result is paginated.

Table 86. /v2/updates/group/{space}
Parameter Description

space

Space/group id
Table 87. Request parameters
Parameter Description

offset

Pagination offset
Example of a request
GET /v2/updates/group/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/updates/group/1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 8962

{
  "offset" : "7c612994-6a98-4152-a0a4-dc2fc224f2bb",
  "items" : [ {
    "id" : "73248f19-1c12-4517-a8cd-93eeb3e24b29",
    "messageCode" : "update.space.trash.filerecord.create",
    "message" : null,
    "lastModified" : 1514764800000,
    "organisationId" : 1,
    "spaceId" : 1,
    "componentId" : 1,
    "componentEntityId" : 1,
    "userId" : 1,
    "targetUserId" : null,
    "componentName" : "Picture 2017-09-28 22-09-58.jpg",
    "reservedName" : null,
    "userName" : "Jack Bauer",
    "targetUserName" : null,
    "users" : [ ],
    "trackingUsers" : [ ],
    "attachments" : [ ],
    "published" : false,
    "commentCount" : 0,
    "component" : null,
    "user" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 616,
        "objectType" : "com.rabbitsoft.clinked.domain.User",
        "objectId" : 1
      },
      "username" : "jack",
      "enabled" : true,
      "locked" : false,
      "twoFactorAuthentication" : false,
      "lastModified" : 1514764800000,
      "lastLogin" : 1514764800000,
      "lastActive" : null,
      "dateCreated" : 1514764800000,
      "dateActivated" : 1514764800000,
      "name" : "Jack Bauer",
      "jobTitle" : "Marketing",
      "organisation" : "Clinked",
      "email" : "jack.bauer@clinked.com",
      "address" : "71 Pilgrim Avenue",
      "telephone" : "123456789",
      "other" : null,
      "logo" : false,
      "timeZone" : "Europe/Riga",
      "locale" : "en",
      "verifiedEmail" : false,
      "twoFactorMode" : null,
      "timeZoneOffset" : 180,
      "type" : "user"
    },
    "targetUser" : null,
    "type" : "update",
    "accountName" : null,
    "groupName" : null,
    "account" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 295,
        "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
        "objectId" : 1
      },
      "creator" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 312,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "awesome_org",
      "friendlyName" : "Awesome Organisation",
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "enabled" : true,
      "domain" : null,
      "mobileSchema" : null,
      "branding" : {
        "backgroundColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "logoLarge" : false,
        "logoMedium" : false,
        "background" : false,
        "favicon" : false,
        "textLogo" : false,
        "gradient" : false,
        "gradientWidth" : 400
      },
      "samlConfiguration" : {
        "entityId" : null,
        "ssoEnabled" : false,
        "userJit" : true,
        "forceSso" : false,
        "adminsUsePassword" : true,
        "disableProfileEdit" : false,
        "forceAuth" : false
      },
      "hash" : null,
      "locale" : null,
      "type" : "account"
    },
    "group" : {
      "id" : 1,
      "comments" : 0,
      "attachments" : 0,
      "contextKey" : {
        "id" : 764,
        "objectType" : "com.rabbitsoft.clinked.domain.Space",
        "objectId" : 1
      },
      "master" : null,
      "owner" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 62,
          "objectType" : "com.rabbitsoft.clinked.domain.User",
          "objectId" : 1
        },
        "username" : "jack",
        "enabled" : true,
        "locked" : false,
        "twoFactorAuthentication" : false,
        "lastModified" : 1514764800000,
        "lastLogin" : 1514764800000,
        "lastActive" : null,
        "dateCreated" : 1514764800000,
        "dateActivated" : 1514764800000,
        "name" : "Jack Bauer",
        "jobTitle" : "Marketing",
        "organisation" : "Clinked",
        "email" : "jack.bauer@clinked.com",
        "address" : "71 Pilgrim Avenue",
        "telephone" : "123456789",
        "other" : null,
        "logo" : false,
        "timeZone" : "Europe/Riga",
        "locale" : "en",
        "verifiedEmail" : false,
        "twoFactorMode" : null,
        "timeZoneOffset" : 180,
        "type" : "user"
      },
      "name" : "explore_clinked",
      "friendlyName" : "Explore Clinked",
      "members" : 0,
      "branding" : {
        "headerColor" : "#ffffff",
        "textColor" : "#ff0000",
        "logo" : false,
        "background" : false,
        "alignment" : "left",
        "backgroundPositionX" : 50,
        "backgroundPositionY" : 50,
        "hideBackgroundGradient" : false,
        "hideLogoBackground" : false,
        "hideGroupName" : false
      },
      "storageConsumed" : 0,
      "dateCreated" : 1514764800000,
      "lastModified" : 1514764800000,
      "mailKey" : null,
      "order" : null,
      "hash" : null,
      "components" : [ {
        "name" : "files",
        "order" : 0,
        "configuration" : { }
      }, {
        "name" : "pages",
        "order" : 1,
        "configuration" : { }
      }, {
        "name" : "events",
        "order" : 2,
        "configuration" : { }
      }, {
        "name" : "tasks",
        "order" : 3,
        "configuration" : { }
      } ],
      "masterConfiguration" : null,
      "blind" : false,
      "disableChat" : false,
      "disableComments" : false,
      "disableEmailComments" : false,
      "hideMemberDetails" : false,
      "disableAccordionWidgets" : true,
      "duplicate" : false,
      "watermarkConfiguration" : {
        "enableWatermark" : false,
        "enableWatermarkIp" : false,
        "enableWatermarkEmail" : false,
        "enableWatermarkTimestamp" : false,
        "enableWatermarkCustomText" : false,
        "watermarkCustomText" : null,
        "watermarkStyle" : null
      },
      "type" : "group",
      "account" : {
        "id" : 1,
        "comments" : 0,
        "attachments" : 0,
        "contextKey" : {
          "id" : 736,
          "objectType" : "com.rabbitsoft.clinked.domain.Organisation",
          "objectId" : 1
        },
        "creator" : {
          "id" : 1,
          "comments" : 0,
          "attachments" : 0,
          "contextKey" : {
            "id" : 796,
            "objectType" : "com.rabbitsoft.clinked.domain.User",
            "objectId" : 1
          },
          "username" : "jack",
          "enabled" : true,
          "locked" : false,
          "twoFactorAuthentication" : false,
          "lastModified" : 1514764800000,
          "lastLogin" : 1514764800000,
          "lastActive" : null,
          "dateCreated" : 1514764800000,
          "dateActivated" : 1514764800000,
          "name" : "Jack Bauer",
          "jobTitle" : "Marketing",
          "organisation" : "Clinked",
          "email" : "jack.bauer@clinked.com",
          "address" : "71 Pilgrim Avenue",
          "telephone" : "123456789",
          "other" : null,
          "logo" : false,
          "timeZone" : "Europe/Riga",
          "locale" : "en",
          "verifiedEmail" : false,
          "twoFactorMode" : null,
          "timeZoneOffset" : 180,
          "type" : "user"
        },
        "name" : "awesome_org",
        "friendlyName" : "Awesome Organisation",
        "dateCreated" : 1514764800000,
        "lastModified" : 1514764800000,
        "enabled" : true,
        "domain" : null,
        "mobileSchema" : null,
        "branding" : {
          "backgroundColor" : "#ffffff",
          "textColor" : "#ff0000",
          "logo" : false,
          "logoLarge" : false,
          "logoMedium" : false,
          "background" : false,
          "favicon" : false,
          "textLogo" : false,
          "gradient" : false,
          "gradientWidth" : 400
        },
        "samlConfiguration" : {
          "entityId" : null,
          "ssoEnabled" : false,
          "userJit" : true,
          "forceSso" : false,
          "adminsUsePassword" : true,
          "disableProfileEdit" : false,
          "forceAuth" : false
        },
        "hash" : null,
        "locale" : null,
        "type" : "account"
      }
    }
  } ],
  "more" : true
}
Table 88. Definition of the returned fields
Path Type Description

offset

String

Pagination offset

items

Array

Page items

more

Boolean

Has next page

items[].id

String

Id

items[].messageCode

String

Message code

items[].message

String

Message text

items[].lastModified

Number

Last modification date

items[].organisationId

Number

Organisation id

items[].spaceId

Number

Group id

items[].componentId

Number

Component id

items[].componentEntityId

Number

Component entity id

items[].userId

Number

Uesr id

items[].targetUserId

Number

Target user id

items[].componentName

String

Component name

items[].reservedName

String

Reserved name

items[].userName

String

Username

items[].targetUserName

String

Target username

items[].attachments

Array

Attachments

items[].component

Object

Component

items[].user

Object

User

items[].targetUser

Object

Target user

3.6.2. List organisation updates

Retrieves a list of organisation updates. Result is paginated.

Table 89. /v2/updates/organisation/{organisation}
Parameter Description

organisation

Organisation/account id
Table 90. Request parameters
Parameter Description

offset

Pagination offset
Example of a request
GET /v2/updates/organisation/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/updates/organisation/1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'
Response example is the same as for List group updates.

3.7. Comments

Pending

3.8. Guests

Pending

4. User

Currently logged in user can retrieve and manage some of his own information.

4.1. Getting user data

Example of a request
GET /v2/users/me HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/users/me' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 793

{
  "id" : 1,
  "comments" : 0,
  "attachments" : 0,
  "contextKey" : {
    "id" : 798,
    "objectType" : "com.rabbitsoft.clinked.domain.User",
    "objectId" : 1
  },
  "username" : "jack",
  "enabled" : true,
  "locked" : false,
  "twoFactorAuthentication" : false,
  "lastModified" : 1514764800000,
  "lastLogin" : 1514764800000,
  "lastActive" : null,
  "dateCreated" : 1514764800000,
  "dateActivated" : 1514764800000,
  "name" : "Jack Bauer",
  "jobTitle" : "Marketing",
  "organisation" : "Clinked",
  "email" : "jack.bauer@clinked.com",
  "address" : "71 Pilgrim Avenue",
  "telephone" : "123456789",
  "other" : null,
  "logo" : false,
  "timeZone" : "Europe/Riga",
  "locale" : "en",
  "verifiedEmail" : false,
  "twoFactorMode" : null,
  "timeZoneOffset" : 180,
  "type" : "user"
}
Table 91. Definition of the returned fields
Path Type Description

id

Number

User id

username

String

Unique username

address

String

Address

name

String

Full name

email

String

E-mail address

enabled

Boolean

Enabled and can sign in

telephone

String

Phone number

organisation

String

Organisation name user works in

jobTitle

String

Job title

locked

Boolean

Locked and can’t sign in

twoFactorAuthentication

Boolean

2FA is enabled

twoFactorMode

String

2FA mode - either SMS or Authenticator

lastModified

Number

Last modification date (timestamp in milliseconds)

lastLogin

Number

Last sign in date (timestamp in milliseconds)

lastActive

Number

Last date time the user was active (timestamp in milliseconds)

dateActivated

Number

Activation date (timestamp in milliseconds)

dateCreated

Number

Creation date (timestamp in milliseconds)

timeZone

String

Local time zone name

timeZoneOffset

Number

Local time zone offset

locale

String

Locale

verifiedEmail

Boolean

Is E-mail address verified

4.2. List user groups

Retrieve all groups a user is a member of.

Example of a request
GET /groups HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/groups' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 3

[ ]
List item fields are defined in Get a single group data

4.3. Notifications

This section is incomplete and provides only request example.

4.3.1. List notifications

Example of a request
GET /v2/notifications HTTP/1.1
Accept: application/json
Host: api.clinked.com

4.3.2. Mark all notifications as read

Example of a request
PUT /v2/notifications HTTP/1.1
Accept: application/json
Host: api.clinked.com

4.3.3. Mark single notification as read

Example of a request
PUT /v2/notifications/1 HTTP/1.1
Accept: application/json
Host: api.clinked.com

4.4. Applications

4.4.1. List user applications

Lists all user applications.

Example of a request
GET /v2/applications HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/applications' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1484

[ {
  "id" : null,
  "owner" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 59,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "clientId" : "7e66abd0-af08-4055-91eb-f067d302f866",
  "clientSecret" : "362a42f6-f6a3-4211-9cc1-904ed405804e",
  "scope" : [ ],
  "name" : "My Awesome App!",
  "description" : "This is my awesome test app",
  "platform" : "OTHER",
  "deviceType" : "Phone",
  "deviceModel" : "Google Pixel XL",
  "deviceOs" : "ANDROID",
  "appVersion" : "1.0",
  "bundleId" : "com.clinked.awesome",
  "deviceToken" : "c24e5dae-2c05-4e0e-a664-02583d43db92",
  "lastActivity" : 1514764800000,
  "ip" : "127.0.0.1",
  "authorities" : [ {
    "authority" : "ROLE_CLIENT"
  } ],
  "registeredRedirectUri" : [ ]
} ]
List item fields are defined in Get single application

4.4.2. Get single application

Table 92. /v2/applications/{application}
Parameter Description

application

Application client id
Example of a request
GET /v2/applications/666d08b7-74c6-41f6-8ade-209d1f3e2609 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/applications/666d08b7-74c6-41f6-8ade-209d1f3e2609' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1481

{
  "id" : null,
  "owner" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 511,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "clientId" : "666d08b7-74c6-41f6-8ade-209d1f3e2609",
  "clientSecret" : "4ab11726-1993-4a26-952c-e4964ce5ca08",
  "scope" : [ ],
  "name" : "My Awesome App!",
  "description" : "This is my awesome test app",
  "platform" : "OTHER",
  "deviceType" : "Phone",
  "deviceModel" : "Google Pixel XL",
  "deviceOs" : "ANDROID",
  "appVersion" : "1.0",
  "bundleId" : "com.clinked.awesome",
  "deviceToken" : "fe595e9a-5cfb-4bf7-ab9b-04ce1efaedac",
  "lastActivity" : 1514764800000,
  "ip" : "127.0.0.1",
  "authorities" : [ {
    "authority" : "ROLE_CLIENT"
  } ],
  "registeredRedirectUri" : [ ]
}
Table 93. Definition of the returned fields
Path Type Description

deviceType

String

Device type: [Phone, Tablet, Watch, Browser, Other]

appVersion

String

Version

name

String

Name

bundleId

String

Bundle/package name

description

String

Description

deviceModel

String

Device model name

deviceToken

String

Device Firebase Cloud Messaging token for notifications

owner

Object

Application owner user

clientId

String

Client id

clientSecret

String

Client secret

scope

Array

Permission scopes

platform

String

Device platform: [IOS, ANDROID, SYNC, LINUX, WINDOWS, OTHER]

deviceOs

String

Device operating system name

authorities

Array

Authorities/roles

4.4.3. Create an application

Table 94. Request fields
Path Type Description

deviceType

String

Device type: [Phone, Tablet, Watch, Browser, Other]

appVersion

String

Version

name

String

Name

bundleId

String

Bundle/package name

description

String

Description

deviceModel

String

Device model name

deviceToken

String

Device Firebase Cloud Messaging token for notifications

platform

String

Device platform: [IOS, ANDROID, SYNC, LINUX, WINDOWS, OTHER]

deviceOs

String

Device operating system name
Example of a request
POST /v2/applications HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 307

{
  "deviceType" : "Phone",
  "appVersion" : "1.0",
  "deviceOs" : "Android",
  "name" : "Awesome App",
  "bundleId" : "com.clinked.awesome",
  "description" : "This is my awesome app",
  "deviceModel" : "Google Pixel XL",
  "platform" : "ANDROID",
  "deviceToken" : "2ba848d4-1c58-4451-912b-60c5b9732cf7"
}
$ curl 'https://api.clinked.com/v2/applications' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "deviceType" : "Phone",
  "appVersion" : "1.0",
  "deviceOs" : "Android",
  "name" : "Awesome App",
  "bundleId" : "com.clinked.awesome",
  "description" : "This is my awesome app",
  "deviceModel" : "Google Pixel XL",
  "platform" : "ANDROID",
  "deviceToken" : "2ba848d4-1c58-4451-912b-60c5b9732cf7"
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1581

{
  "id" : null,
  "owner" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 500,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "clientId" : "79df4f5fb1e6437a36456aeea5bb5242",
  "clientSecret" : "40a3d77b5ca14b1094619a3031149577",
  "scope" : [ "read", "write", "smartsync" ],
  "name" : "Awesome App",
  "description" : "This is my awesome app",
  "platform" : "ANDROID",
  "deviceType" : "Phone",
  "deviceModel" : "Google Pixel XL",
  "deviceOs" : "Android",
  "appVersion" : "1.0",
  "bundleId" : "com.clinked.awesome",
  "deviceToken" : "2ba848d4-1c58-4451-912b-60c5b9732cf7",
  "lastActivity" : null,
  "ip" : null,
  "authorities" : [ {
    "authority" : "ROLE_CLIENT"
  }, {
    "authority" : "READ"
  }, {
    "authority" : "WRITE"
  }, {
    "authority" : "SMARTSYNC"
  } ],
  "registeredRedirectUri" : [ ]
}
List item fields are defined in Get single application

4.4.4. Update an application

Table 95. /v2/applications/{application}
Parameter Description

application

Application client id
Table 96. Request fields
Path Type Description

deviceType

String

Device type: [Phone, Tablet, Watch, Browser, Other]

appVersion

String

Version

name

String

Name

bundleId

String

Bundle/package name

description

String

Description

deviceModel

String

Device model name

deviceToken

String

Device Firebase Cloud Messaging token for notifications

platform

String

Device platform: [IOS, ANDROID, SYNC, LINUX, WINDOWS, OTHER]

deviceOs

String

Device operating system name
Example of a request
PUT /v2/applications/76d1221c-ac38-4670-822e-bd253209f8c8 HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 307

{
  "deviceType" : "Phone",
  "appVersion" : "1.0",
  "deviceOs" : "Android",
  "name" : "Awesome App",
  "bundleId" : "com.clinked.awesome",
  "description" : "This is my awesome app",
  "deviceModel" : "Google Pixel XL",
  "platform" : "ANDROID",
  "deviceToken" : "78bc74a6-0f9e-4abc-83ff-cab2bbec6c17"
}
$ curl 'https://api.clinked.com/v2/applications/76d1221c-ac38-4670-822e-bd253209f8c8' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "deviceType" : "Phone",
  "appVersion" : "1.0",
  "deviceOs" : "Android",
  "name" : "Awesome App",
  "bundleId" : "com.clinked.awesome",
  "description" : "This is my awesome app",
  "deviceModel" : "Google Pixel XL",
  "platform" : "ANDROID",
  "deviceToken" : "78bc74a6-0f9e-4abc-83ff-cab2bbec6c17"
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1474

{
  "id" : null,
  "owner" : {
    "id" : 1,
    "comments" : 0,
    "attachments" : 0,
    "contextKey" : {
      "id" : 385,
      "objectType" : "com.rabbitsoft.clinked.domain.User",
      "objectId" : 1
    },
    "username" : "jack",
    "enabled" : true,
    "locked" : false,
    "twoFactorAuthentication" : false,
    "lastModified" : 1514764800000,
    "lastLogin" : 1514764800000,
    "lastActive" : null,
    "dateCreated" : 1514764800000,
    "dateActivated" : 1514764800000,
    "name" : "Jack Bauer",
    "jobTitle" : "Marketing",
    "organisation" : "Clinked",
    "email" : "jack.bauer@clinked.com",
    "address" : "71 Pilgrim Avenue",
    "telephone" : "123456789",
    "other" : null,
    "logo" : false,
    "timeZone" : "Europe/Riga",
    "locale" : "en",
    "verifiedEmail" : false,
    "twoFactorMode" : null,
    "timeZoneOffset" : 180,
    "type" : "user"
  },
  "clientId" : "76d1221c-ac38-4670-822e-bd253209f8c8",
  "clientSecret" : "bc0549fa-168d-496d-82eb-3a1daaefa855",
  "scope" : [ ],
  "name" : "Awesome App",
  "description" : "This is my awesome app",
  "platform" : "ANDROID",
  "deviceType" : "Phone",
  "deviceModel" : "Google Pixel XL",
  "deviceOs" : "Android",
  "appVersion" : "1.0",
  "bundleId" : "com.clinked.awesome",
  "deviceToken" : "78bc74a6-0f9e-4abc-83ff-cab2bbec6c17",
  "lastActivity" : 1514764800000,
  "ip" : "127.0.0.1",
  "authorities" : [ {
    "authority" : "ROLE_CLIENT"
  } ],
  "registeredRedirectUri" : [ ]
}
List item fields are defined in Get single application

4.4.5. Delete an application

Deletes and revokes application access.

Table 97. /v2/applications/{application}
Parameter Description

application

Application client id
Example of a request
DELETE /v2/applications/3798b2d1-347b-4622-87c9-f973e395153c HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/applications/3798b2d1-347b-4622-87c9-f973e395153c' -i -X DELETE \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK

4.5. User properties

Each user has its own map (key → value) of properties that can be used to change personal preferences.

4.5.1. List properties

Lists all user properties.

Example of a request
GET /v2/users/properties HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/users/properties' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 172

[ {
  "name" : "user.property.name1",
  "value" : "value1",
  "sensitivity" : false
}, {
  "name" : "user.property.name2",
  "value" : "value2",
  "sensitivity" : false
} ]
Table 98. Definition of the returned fields
Path Type Description

[].name

String

Property name

[].sensitivity

Boolean

Property contains sensitive information or not

[].value

String

Property value

4.5.2. Create a property

Creates a user property.

Example of a request
POST /v2/users/properties HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 81

{
  "name" : "user.property.name",
  "value" : "value",
  "sensitivity" : false
}
$ curl 'https://api.clinked.com/v2/users/properties' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "name" : "user.property.name",
  "value" : "value",
  "sensitivity" : false
}'
Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 116

{
  "id" : null,
  "context" : null,
  "name" : "user.property.name",
  "value" : "value",
  "sensitivity" : false
}
Table 99. Definition of the returned fields
Path Type Description

name

String

Property name

value

String

Property value

sensitivity

Boolean

Property contains sensitive information or not

4.5.3. Delete a property

Deletes a user property.

Table 100. /v2/users/properties/{property}
Parameter Description

property

Property name
Example of a request
DELETE /v2/users/properties/user.property.name HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ curl 'https://api.clinked.com/v2/users/properties/user.property.name' -i -X DELETE \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'
Example of a success response
HTTP/1.1 200 OK

5. Appendix A: Forbidden file names

  • new

  • delete

  • download

  • clipboard

6. Appendix B: Forbidden user names

  • invite

  • list

  • tags

  • anonymous

  • websocket

  • webhooks

  • messages

  • signup

  • site

  • ping

  • static

  • customise

  • users

  • uses

  • password

  • settings

  • search

  • packages

  • clientcountry

  • shares

  • login

  • verify_code

  • .

  • favicon.ico

  • robots.txt

  • new_space

  • new_space_duplicate

  • uncaught_exception

  • access_denied

  • not_found

  • userdata

  • following

  • _jserr

  • api

  • google

  • linkedin

  • image

  • messages

  • mentions

  • token_password

  • requests

  • activity

  • activity_share

  • tracking

  • events

  • tasks

  • spaces

  • people

  • pages

  • discussions

  • files

  • generalinfo

  • tinymce

  • getting_started

  • conversation

  • notifications

  • members

  • websocket

  • webhooks

7. Appendix C: Forbidden group names

  • websocket

  • webhooks

  • messages

  • signup

  • site

  • ping

  • static

  • customise

  • users

  • uses

  • password

  • settings

  • search

  • packages

  • clientcountry

  • shares

  • login

  • verify_code

  • .

  • favicon.ico

  • robots.txt

  • new_space

  • new_space_duplicate

  • uncaught_exception

  • access_denied

  • not_found

  • userdata

  • following

  • _jserr

  • api

  • google

  • linkedin

  • image

  • messages

  • mentions

  • token_password

  • requests

  • activity

  • activity_share

  • tracking

  • events

  • tasks

  • spaces

  • people

  • pages

  • discussions

  • files

  • generalinfo

  • tinymce

  • getting_started

  • conversation

  • notifications

  • members

  • websocket

  • webhooks

8. Appendix D: Update templates

update.organisation.create={0} created account {1}
update.organisation.disable={0} disabled account {1}
update.organisation.enabled={0} enabled account {1}

update.user.private={0} said
update.user.profile={0} said to {4}
update.organisation.private={0} in {1} said
update.organisation.join={0} joined {1}
update.space.private={0} in {2} said
update.following.start={0} started following {3} in {2}
update.following.stop={0} stopped following {3} in {2}
update.discussion.create={0} created new [discussions:0:0] {3} in {2}
update.discussion.update={0} updated [discussions:0:0] {3} in {2}
update.discussion.createreply={0} replied to [discussions:0:0] {3} in {2}
update.space.create={0} created a new [spaces:0:0] {2}
update.space.join={0} joined {2} [spaces:0:0]
update.trash.remove={0} deleted [spaces:0:0] {2}
update.trash.restore={0} restored [spaces:0:0] {2}
update.trash.delete={0} deleted [spaces:0:0] {2} from {1} trash
update.filestore.create={0} uploaded [files:0:0] {3} in {2}
update.filestore.update={0} updated [files:0:0] {3} in {2}
update.filestore.folder={0} created folder {3} in {2}
update.filestore.sign=The agreement <strong>{5}</strong> for file {3} in {2} is signed and ready to download.
update.filestore.rename={0} renamed "{5}" to {3} in {2}
update.filestore.move={0} moved {3} to "{5}" in {2}
update.filestore.copy={0} copied {3} to "{5}" in {2}
update.filestore.approval.accept={0} approved [files:0:0] {3} in {2}
update.filestore.approval.reject={0} rejected [files:0:0] {3} in {2}
update.event.create={0} created [events:0:0] {3} in {2}
update.event.createandassign={0} created [events:0:0] {3} in {2}
update.event.update={0} updated [events:0:0] {3} in {2}
update.event.updateandassign={0} updated [events:0:0] {3} in {2}
update.task.create={0} created [tasks:0:0] {3} in {2}
update.task.createandassign={0} created [tasks:0:0] {3} in {2}
update.task.update={0} updated [tasks:0:0] {3} in {2}
update.task.updateandassign={0} updated [tasks:0:0] {3} in {2}
update.task.complete={0} completed [tasks:0:0] {3} in {2}
update.task.reopen={0} marked [tasks:0:0] {3} as incomplete in {2}

update.attachment.create={0} attached file {5} to {3} in {2}
update.attachment.update={0} updated attachment {5} in {3}

update.page.create={0} created new [pages:0:0] {3} in {2}
update.page.update={0} updated [pages:0:0] {3} in {2}
update.page.restore={0} restored [pages:0:0] {3} version {5} in {2}
update.page.renameandupdate={0} moved [pages:0:0] {5} to {3} in {2}

update.news.create={0} created new [news:0:0] {3} in {2}
update.news.update={0} updated [news:0:0] {3} in {2}
update.news.restore={0} restored [news:0:0] {3} version {5} in {2}
update.news.renameandupdate={0} moved [news:0:0] {5} to {3} in {2}

update.comment.create={0} commented on {3} in {2}
update.comment.update={0} updated comment on {3} in {2}

update.comment.delete={0} deleted comment from {3} in {2}

update.comment.reply={0} replied on {3} in {2}
update.comment.reaction={0} reacted to a comment on {3} in {2}
update.annotate.create={0} annotated {3} in {2}
update.annotate.delete={0} deleted annotation from {3} in {2}

update.space.trash.filerecord.create={0} deleted {3} in {2}
update.space.trash.filerecord.attemptRestore={0} restored {3} in {2}
update.space.trash.filerecord.delete={0} permanently deleted {3} from {2} trash
update.space.trash.page.create={0} deleted [pages:0:0] {3} in {2}
update.space.trash.page.attemptRestore={0} restored [pages:0:0] {3} in {2}
update.space.trash.page.delete={0} permanently deleted [pages:0:0] {3} from {2} trash
update.space.trash.news.create={0} deleted [news:0:0] {3} in {2}
update.space.trash.news.attemptRestore={0} restored [news:0:0] {3} in {2}
update.space.trash.news.delete={0} permanently deleted [news:0:0] {3} from {2} trash

update.space.trash.discussion.create={0} deleted [discussions:0:0] {3} in {2}
update.space.trash.discussion.attemptRestore={0} restored [discussions:0:0] {3} in {2}
update.space.trash.discussion.delete={0} permanently deleted [discussions:0:0] {3} from {2} trash
update.space.trash.event.create={0} deleted [events:0:0] {3} in {2}
update.space.trash.event.attemptRestore={0} restored [events:0:0] {3} in {2}
update.space.trash.event.delete={0} permanently deleted [events:0:0] {3} from {2} trash
update.space.trash.task.create={0} deleted [tasks:0:0] {3} in {2}
update.space.trash.task.attemptRestore={0} restored [tasks:0:0] {3} in {2}
update.space.trash.task.delete={0} permanently deleted [tasks:0:0] {3} from {2} trash
update.space.rename={0} renamed [spaces:0:0] {5} to {2}
update.space.move={0} moved [spaces:0:0] {2} from {3}
update.space.remove={0} removed [spaces:0:0] {2}
update.space.restore={0} restored [spaces:0:0] {2} from trash

update.attachment.create.notify={0} attached the file {2} to {1}
update.attachment.update.notify={0} updated the attachment {2} to {1}
update.discussion.createreply.notify={0} replied to [discussions:0:0] {1}
update.event.update.notify={0} edited the [events:0:0] {1}
update.event.updateandassign.notify={0} edited the [events:0:0] {1}
update.filestore.update.notify={0} edited the [files:0:0] {1}
update.filestore.folder.notify={0} created folder {1}
update.filestore.create.notify={0} created a new [files:0:0] {1}
update.page.update.notify={0} changed the [pages:0:0] {1}
update.page.renameandupdate.notify={0} changed the [pages:0:0] {1}
update.space.trash.discussion.create.notify={0} deleted the [discussions:0:0] {1}
update.space.trash.event.create.notify={0} deleted the [events:0:0] {1}
update.space.trash.filerecord.create.notify={0} deleted the [files:0:0] {1}
update.space.trash.news.create.notify={0} deleted the [news:0:0] {1}
update.space.trash.page.create.notify={0} deleted the [pages:0:0] {1}
update.space.trash.task.create.notify={0} deleted the [tasks:0:0] {1}
update.space.trash.discussion.attemptRestore.notify={0} restored the [discussions:0:0] {1}
update.space.trash.event.attemptRestore.notify={0} restored the [events:0:0] {1}
update.space.trash.filerecord.attemptRestore.notify={0} restored the [files:0:0] {1}
update.space.trash.page.attemptRestore.notify={0} restored the [pages:0:0] {1}
update.space.trash.news.attemptRestore.notify={0} restored the [news:0:0] {1}
update.space.trash.task.attemptRestore.notify={0} restored the [tasks:0:0] {1}
update.task.complete.notify={0} completed the [tasks:0:0] {1}
update.task.reopen.notify={0} marked the [tasks:0:0] {1} as uncompleted
update.task.update.notify={0} changed the [tasks:0:0] {1}
update.task.updateandassign.notify={0} changed the [tasks:0:0] {1}
update.comment.create.notify={0} commented on {1}
update.comment.reply.notify={0} commented on {1}