1. Overview
Content such as a file or note can be shared with someone who is not a member of your account. How to share content see Create share for details.
For more information about the feature itself, see our Help Center page. |
1.1. Guest Authentication
GET /oauth/token?client_id=clinked-guests&grant_type=share&token=5bcf0f7a-ebf3-45cc-aa1e-096281b2b1a9
HTTP/1.1
Host: api.clinked.com
Parameter | Description |
---|---|
|
Client id for guest should be - clinked-guests |
|
Grant type for guest should be - share |
|
Share token |
2. Guest shares
2.1. List shared content
GET /v3/shares HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares' \
'Content-Type:application/json' \
'Accept:application/json' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 600
[ {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"contentContext" : {
"id" : 620
},
"dateCreated" : 1514764800000,
"dateExpire" : null,
"email" : "email@example.com",
"tokenKey" : "e7163db3-332a-4f07-960e-64a51cc39e41",
"permission" : 1,
"passwordEnabled" : false,
"notifications" : false,
"component" : {
"id" : 1,
"contextKey" : {
"id" : 157
},
"type" : "page",
"name" : "home_page",
"friendlyName" : "Home Page"
}
} ]
Path | Type | Description |
---|---|---|
|
|
Optional user |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Content context id |
|
|
Date created |
|
|
Date expired |
|
|
Guest email |
|
|
Token key |
|
|
Permission |
|
|
Permission |
|
|
Notifications enabled |
|
|
Shared component |
|
|
Component id |
|
|
Context key id |
|
|
Component type - discussion, page, event, file, page, task |
|
|
Component name |
|
|
Component friendly name |
2.2. Get shared content
Parameter | Description |
---|---|
|
Share token |
GET /v3/shares/f5e44fb2-a019-4a1c-a6d7-2528f3fc7ac5 HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/f5e44fb2-a019-4a1c-a6d7-2528f3fc7ac5' \
'Content-Type:application/json' \
'Accept:application/json' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/f5e44fb2-a019-4a1c-a6d7-2528f3fc7ac5' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 434
{
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"contentContext" : {
"id" : 794
},
"dateCreated" : 1514764800000,
"dateExpire" : null,
"email" : "email@example.com",
"tokenKey" : "f5e44fb2-a019-4a1c-a6d7-2528f3fc7ac5",
"permission" : 1,
"passwordEnabled" : false,
"notifications" : false
}
Path | Type | Description |
---|---|---|
|
|
Optional user |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Content context id |
|
|
Date created |
|
|
Date expired |
|
|
Guest email |
|
|
Token key |
|
|
Permission |
|
|
Permission |
|
|
Notifications enabled |
3. Discussions
3.1. Single discussion
Parameter | Description |
---|---|
|
Share token |
GET /v3/shares/3375c70e-df6f-4ee9-a505-88c317de5658/discussion HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/3375c70e-df6f-4ee9-a505-88c317de5658/discussion' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/3375c70e-df6f-4ee9-a505-88c317de5658/discussion' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1162
{
"id" : 1,
"contextKey" : {
"id" : 26
},
"sharing" : "MEMBERS",
"memberPermission" : 2,
"attachmentCount" : 0,
"name" : "great_discussion",
"friendlyName" : "Great discussion",
"tags" : "",
"description" : "What do you think about this?",
"replies" : 5,
"dateCreated" : 1514764800000,
"lastModified" : 1514764800000,
"author" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
}
Path | Type | Description |
---|---|---|
|
|
discussion id |
|
|
Context key |
|
|
Context key ID |
|
|
Level of sharing |
|
|
Permission level |
|
|
Discussion name |
|
|
Discussion name |
|
|
Tags |
|
|
Discussion description |
|
|
Reply count |
|
|
Date created |
|
|
Date last modified |
|
|
Attachment count |
|
|
User’s full name |
|
|
Detailed user data, will be set to null if user is deleted |
|
|
User username if user is defined |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User / profile id |
|
|
Group name slug, used for internal identification and URIs |
|
|
Full group name, visible to a user |
|
|
Is commenting disabled for group |
|
|
Group branding settings |
|
|
Header background color |
|
|
Text color |
|
|
Logo exists |
|
|
Logo alignment |
|
|
Background exists |
|
|
Background image X position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Group hash value |
3.3. List replies
Parameter | Description |
---|---|
|
Share token |
GET /v3/shares/d275d551-7996-4605-84e9-62e74a9f517f/discussion/replies?page=1&size=10 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/d275d551-7996-4605-84e9-62e74a9f517f/discussion/replies?page=1&size=10' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/d275d551-7996-4605-84e9-62e74a9f517f/discussion/replies?page=1&size=10' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
Parameter | Description |
---|---|
|
Page number |
|
Page size |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 704
{
"items" : [ {
"id" : 1,
"reply" : "reply text",
"dateCreated" : 1514764800000,
"author" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"reactions" : {
"totalReactions" : 3,
"userReaction" : "THUMBS_UP",
"thumbsUp" : 1,
"thumbsDown" : 0,
"heart" : 0,
"openEye" : 0,
"fire" : 0
}
} ],
"currentPage" : 1,
"totalPages" : 1,
"pageSize" : 1,
"totalResults" : 1,
"nextPage" : false,
"previousPage" : false
}
Path | Type | Description |
---|---|---|
|
|
Page items |
|
|
Current page number |
|
|
Current page size |
|
|
Next page available |
|
|
Previous page available |
|
|
Amount of available pages |
|
|
Total results |
|
|
Reply id |
|
|
Reply text |
|
|
Date created |
|
|
User’s full name |
|
|
Detailed user data, will be set to null if user is deleted |
|
|
User username if user is defined |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Number of total reactions |
|
|
Reaction - [THUMBS_UP, THUMBS_DOWN, HEART, OPEN_EYE, FIRE] |
|
|
Number of thumbs up |
|
|
Number of thumbs down |
|
|
Number of hearts |
|
|
Number of open eye |
|
|
Number of fire |
3.4. Create reply
Parameter | Description |
---|---|
|
Share token |
POST /v3/shares/87af9f33-4a6e-4c26-9428-6b60f5e51c87/discussion/replies HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 23
{
"reply" : "Hello"
}
$ echo '{
"reply" : "Hello"
}' | http POST 'https://api.clinked.com/v3/shares/87af9f33-4a6e-4c26-9428-6b60f5e51c87/discussion/replies' \
'Content-Type:application/json' \
'Authorization:Bearer <YOUR-TOKEN>' \
'Accept:application/json'
$ curl 'https://api.clinked.com/v3/shares/87af9f33-4a6e-4c26-9428-6b60f5e51c87/discussion/replies' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-H 'Accept: application/json' \
-d '{
"reply" : "Hello"
}'
Path | Type | Description |
---|---|---|
|
|
Reply text |
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 351
{
"id" : 1,
"reply" : "reply text",
"dateCreated" : 1514764800000,
"author" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"reactions" : null
}
Path | Type | Description |
---|---|---|
|
|
Reply id |
|
|
Reply text |
|
|
Date created |
|
|
User’s full name |
|
|
Detailed user data, will be set to null if user is deleted |
|
|
User username if user is defined |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Reactions |
4. Events
4.1. Single event
Parameter | Description |
---|---|
|
Share token |
GET /v3/shares/fd243737-9e62-4ba8-bffd-1af609101c66/events HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/fd243737-9e62-4ba8-bffd-1af609101c66/events' \
'Content-Type:application/json' \
'Authorization:Bearer <YOUR-TOKEN>' \
'Accept:application/json'
$ curl 'https://api.clinked.com/v3/shares/fd243737-9e62-4ba8-bffd-1af609101c66/events' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-H 'Accept: application/json'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1393
{
"id" : 1,
"contextKey" : {
"id" : 809
},
"sharing" : "MEMBERS",
"memberPermission" : 8,
"attachmentCount" : 0,
"commentCount" : 0,
"name" : "meeting_with_a_client",
"friendlyName" : "Meeting with a client",
"startDate" : "2018-01-05T14:00Z[UTC]",
"endDate" : "2018-01-05T15:00Z[UTC]",
"allDay" : false,
"location" : "London",
"tags" : "tag1,tag2",
"dateReminder" : "2017-12-31T08:00Z[UTC]",
"recurrence" : "FREQ=WEEKLY;WKST=MO;BYDAY=FR",
"dateEndRecurrence" : "2025-06-06T08:11:09.575Z[UTC]",
"description" : "Let's do this every friday",
"disableMaybe" : false,
"author" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"lastModified" : 1514764800000,
"color" : "#212121",
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
}
Path | Type | Description |
---|---|---|
|
|
Event ID |
|
|
Context key |
|
|
Context key ID |
|
|
Sharing option, determines who can see an event: [NONE, DEFAULT, MEMBERS, PUBLIC] |
|
|
Member permission mask |
|
|
Event author |
|
|
Amount of attachments |
|
|
Unique name |
|
|
Full name |
|
|
Event start date |
|
|
Event end date |
|
|
All day event |
|
|
Event location |
|
|
Comma separated list of tags |
|
|
When to send a reminder about an event |
|
|
Valid recurrence rule |
|
|
Recurrence end date |
|
|
Event description |
|
|
List of users invited to the event |
|
|
Date last modified |
|
|
Do not allow invited members to choose 'maybe' option |
|
|
Comment count |
|
|
Event color |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User / profile id |
|
|
Group name slug, used for internal identification and URIs |
|
|
Full group name, visible to a user |
|
|
Is commenting disabled for group |
|
|
Group branding settings |
|
|
Header background color |
|
|
Text color |
|
|
Logo exists |
|
|
Logo alignment |
|
|
Background exists |
|
|
Background image X position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Group hash value |
5. Notes
5.1. Single note
Parameter | Description |
---|---|
|
Share token |
GET /v3/shares/af296662-d451-43bc-adcb-9b1434f4da1c/notes HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/af296662-d451-43bc-adcb-9b1434f4da1c/notes' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/af296662-d451-43bc-adcb-9b1434f4da1c/notes' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1571
{
"id" : 1,
"contextKey" : {
"id" : 888
},
"sharing" : "MEMBERS",
"memberPermission" : 8,
"attachmentCount" : 0,
"commentCount" : 0,
"name" : "home_page",
"friendlyName" : "Home Page",
"template" : false,
"tags" : "lorem,ipsum",
"content" : "",
"dateCreated" : 1514764800000,
"lastModified" : 1514764800000,
"creator" : {
"id" : 1,
"username" : "jack",
"enabled" : true,
"locked" : false,
"name" : "Jack Bauer",
"jobTitle" : "Marketing",
"organisation" : "Clinked",
"email" : "jack.bauer@clinked.com",
"address" : "71 Pilgrim Avenue",
"telephone" : "123456789",
"other" : null,
"logo" : false,
"timeZone" : "UTC",
"locale" : "en",
"verifiedEmail" : false,
"twoFactorAuthentication" : false,
"twoFactorMode" : null,
"lastModified" : 1514764800000,
"dateFormat" : null,
"twentyFourHourTimeFormat" : false,
"lastActive" : null
},
"versions" : 1,
"attachments" : [ ],
"pageType" : "FOLDER",
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
}
Path | Type | Description |
---|---|---|
|
|
Note id |
|
|
Unique name (slug) |
|
|
Name |
|
|
Context key |
|
|
Context key ID |
|
|
Base details about group |
|
|
Is a template |
|
|
Comma-separated list of tags |
|
|
Note content |
|
|
Sharing option, determines who can see a note: [NONE, DEFAULT, MEMBERS, PUBLIC] |
|
|
Member file permission mask |
|
|
Amount of attachments |
|
|
Amount of comments |
|
|
List of attachments |
|
|
User created the page |
|
|
Date when note was last modified |
|
|
Total page vesions |
|
|
Date when note was created |
|
|
PAGE or FOLDER |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Is user enabled |
|
|
Is user locked |
|
|
Organisation name |
|
|
Email address |
|
|
Address |
|
|
Phone number |
|
|
Optional other information |
|
|
Time zone ID |
|
|
Locale |
|
|
Is email verified |
|
|
Is 2FA enabled |
|
|
2FA mode: [AUTHENTICATOR, SMS, EMAIL] |
|
|
Time format preference - 24hr or 12hr format |
|
|
Date the user was last active |
|
|
Date format preference - YMD (Year-Month-Day), MDY (Month/Day/Year) or DMY(Day/Month/Year) |
|
|
User / profile id |
|
|
Group name slug, used for internal identification and URIs |
|
|
Full group name, visible to a user |
|
|
Is commenting disabled for group |
|
|
Group branding settings |
|
|
Header background color |
|
|
Text color |
|
|
Logo exists |
|
|
Logo alignment |
|
|
Background exists |
|
|
Background image X position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Group hash value |
5.2. Note Folder
Lists notes in shared note folder.
Parameter | Description |
---|---|
|
Share token |
GET /v3/shares/84ba1576-b357-4104-a86c-fc4aec621cbd/notes?parentId=1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/84ba1576-b357-4104-a86c-fc4aec621cbd/notes?parentId=1' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/84ba1576-b357-4104-a86c-fc4aec621cbd/notes?parentId=1' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
Parameter | Description |
---|---|
|
Shared note folder id |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1768
{
"items" : [ {
"id" : 1,
"contextKey" : {
"id" : 970
},
"sharing" : "MEMBERS",
"memberPermission" : 8,
"name" : "home_page",
"friendlyName" : "Home Page",
"template" : false,
"tags" : "lorem,ipsum",
"content" : "",
"dateCreated" : 1514764800000,
"lastModified" : 1514764800000,
"creator" : {
"id" : 1,
"username" : "jack",
"enabled" : true,
"locked" : false,
"name" : "Jack Bauer",
"jobTitle" : "Marketing",
"organisation" : "Clinked",
"email" : "jack.bauer@clinked.com",
"address" : "71 Pilgrim Avenue",
"telephone" : "123456789",
"other" : null,
"logo" : false,
"timeZone" : "UTC",
"locale" : "en",
"verifiedEmail" : false,
"twoFactorAuthentication" : false,
"twoFactorMode" : null,
"lastModified" : 1514764800000,
"dateFormat" : null,
"twentyFourHourTimeFormat" : false,
"lastActive" : null
},
"versions" : 1,
"pageType" : "PAGE",
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
} ],
"currentPage" : 1,
"totalPages" : 1,
"pageSize" : 1,
"totalResults" : 1,
"nextPage" : false,
"previousPage" : false
}
Path | Type | Description |
---|---|---|
|
|
Note id |
|
|
Unique name (slug) |
|
|
Name |
|
|
Context key |
|
|
Context key ID |
|
|
Base details about group |
|
|
Is a template |
|
|
Comma-separated list of tags |
|
|
Note content |
|
|
Sharing option, determines who can see a note: [NONE, DEFAULT, MEMBERS, PUBLIC] |
|
|
Member file permission mask |
|
|
Amount of attachments |
|
|
Amount of comments |
|
|
List of attachments |
|
|
User created the page |
|
|
Date when note was last modified |
|
|
Total page vesions |
|
|
Date when note was created |
|
|
PAGE or FOLDER |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Is user enabled |
|
|
Is user locked |
|
|
Organisation name |
|
|
Email address |
|
|
Address |
|
|
Phone number |
|
|
Optional other information |
|
|
Time zone ID |
|
|
Locale |
|
|
Is email verified |
|
|
Is 2FA enabled |
|
|
2FA mode: [AUTHENTICATOR, SMS, EMAIL] |
|
|
Time format preference - 24hr or 12hr format |
|
|
Date the user was last active |
|
|
Date format preference - YMD (Year-Month-Day), MDY (Month/Day/Year) or DMY(Day/Month/Year) |
|
|
User / profile id |
|
|
Group name slug, used for internal identification and URIs |
|
|
Full group name, visible to a user |
|
|
Is commenting disabled for group |
|
|
Group branding settings |
|
|
Header background color |
|
|
Text color |
|
|
Logo exists |
|
|
Logo alignment |
|
|
Background exists |
|
|
Background image X position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Group hash value |
|
|
Page items |
|
|
Current page number |
|
|
Current page size |
|
|
Next page available |
|
|
Previous page available |
|
|
Amount of available pages |
|
|
Total results |
5.3. Note in shared folder
Parameter | Description |
---|---|
|
Share token |
|
Note id |
GET /v3/shares/f36100c4-5483-4ebd-9e7e-8c3e43814c16/notes/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/f36100c4-5483-4ebd-9e7e-8c3e43814c16/notes/1' \
'Authorization:Bearer <YOUR-TOKEN>'
include::/home/ec2-user/clinked/clinked-api-webapp/target/generated-snippets/v3/shares/notes/subnote/curl-request.adoc[
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1569
{
"id" : 1,
"contextKey" : {
"id" : 338
},
"sharing" : "MEMBERS",
"memberPermission" : 8,
"attachmentCount" : 0,
"commentCount" : 0,
"name" : "home_page",
"friendlyName" : "Home Page",
"template" : false,
"tags" : "lorem,ipsum",
"content" : "",
"dateCreated" : 1514764800000,
"lastModified" : 1514764800000,
"creator" : {
"id" : 1,
"username" : "jack",
"enabled" : true,
"locked" : false,
"name" : "Jack Bauer",
"jobTitle" : "Marketing",
"organisation" : "Clinked",
"email" : "jack.bauer@clinked.com",
"address" : "71 Pilgrim Avenue",
"telephone" : "123456789",
"other" : null,
"logo" : false,
"timeZone" : "UTC",
"locale" : "en",
"verifiedEmail" : false,
"twoFactorAuthentication" : false,
"twoFactorMode" : null,
"lastModified" : 1514764800000,
"dateFormat" : null,
"twentyFourHourTimeFormat" : false,
"lastActive" : null
},
"versions" : 1,
"attachments" : [ ],
"pageType" : "PAGE",
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
}
Path | Type | Description |
---|---|---|
|
|
Note id |
|
|
Unique name (slug) |
|
|
Name |
|
|
Context key |
|
|
Context key ID |
|
|
Base details about group |
|
|
Is a template |
|
|
Comma-separated list of tags |
|
|
Note content |
|
|
Sharing option, determines who can see a note: [NONE, DEFAULT, MEMBERS, PUBLIC] |
|
|
Member file permission mask |
|
|
Amount of attachments |
|
|
Amount of comments |
|
|
List of attachments |
|
|
User created the page |
|
|
Date when note was last modified |
|
|
Total page vesions |
|
|
Date when note was created |
|
|
PAGE or FOLDER |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Is user enabled |
|
|
Is user locked |
|
|
Organisation name |
|
|
Email address |
|
|
Address |
|
|
Phone number |
|
|
Optional other information |
|
|
Time zone ID |
|
|
Locale |
|
|
Is email verified |
|
|
Is 2FA enabled |
|
|
2FA mode: [AUTHENTICATOR, SMS, EMAIL] |
|
|
Time format preference - 24hr or 12hr format |
|
|
Date the user was last active |
|
|
Date format preference - YMD (Year-Month-Day), MDY (Month/Day/Year) or DMY(Day/Month/Year) |
|
|
User / profile id |
|
|
Group name slug, used for internal identification and URIs |
|
|
Full group name, visible to a user |
|
|
Is commenting disabled for group |
|
|
Group branding settings |
|
|
Header background color |
|
|
Text color |
|
|
Logo exists |
|
|
Logo alignment |
|
|
Background exists |
|
|
Background image X position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Group hash value |
5.5. List versions
Parameter | Description |
---|---|
|
Share Token |
GET /v3/shares/b0ace47f-4f6e-468e-808d-5f73ef1db518/notes/versions HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/b0ace47f-4f6e-468e-808d-5f73ef1db518/notes/versions' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/b0ace47f-4f6e-468e-808d-5f73ef1db518/notes/versions' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
Parameter | Description |
---|---|
|
Page number to load |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1392
{
"items" : [ {
"id" : 31,
"versionNumber" : 1,
"uploaded" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"summary" : "Pol, a bene elevatus, historia!",
"lastModified" : 1749197472227
}, {
"id" : 32,
"versionNumber" : 2,
"uploaded" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"summary" : "Pol, a bene elevatus, historia!",
"lastModified" : 1749197472227
}, {
"id" : 33,
"versionNumber" : 3,
"uploaded" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"summary" : "Pol, a bene elevatus, historia!",
"lastModified" : 1749197472227
} ],
"currentPage" : 1,
"totalPages" : 1,
"pageSize" : 3,
"totalResults" : 3,
"nextPage" : false,
"previousPage" : false
}
Path | Type | Description |
---|---|---|
|
|
Page items |
|
|
Current page number |
|
|
Current page size |
|
|
Next page available |
|
|
Previous page available |
|
|
Amount of available pages |
|
|
Total results |
|
|
ID |
|
|
Version number |
|
|
A safe user who uploaded a file |
|
|
Version description / summary |
|
|
Last modification timestamp |
|
|
User’s full name |
|
|
User’s usernae if the user is defined |
|
|
Detailed user data, will be set to null if user is deleted |
|
|
User / profile id |
|
|
Full name |
|
|
Username |
|
|
Avatar available |
|
|
Job title |
|
|
Last profile update date |
5.6. Download version
Parameter | Description |
---|---|
|
Version number |
|
Share token |
GET /v3/shares/6ab0180c-d5b7-408f-a044-924ab06863ba/notes/versions/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/6ab0180c-d5b7-408f-a044-924ab06863ba/notes/versions/1' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/6ab0180c-d5b7-408f-a044-924ab06863ba/notes/versions/1' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
Content-Disposition: attachment; filename="Home Page"
Last-Modified: Fri, 06 Jun 2025 08:11:12 GMT
Content-Length: 5
Content-Type: text/html
Accept-Ranges: bytes
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
hello
6. Tasks
6.1. Single task
Parameter | Description |
---|---|
|
Share token |
GET /v3/shares/2b69dc5f-7b53-4e00-bf26-7be87d1709d8/tasks HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/2b69dc5f-7b53-4e00-bf26-7be87d1709d8/tasks' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/2b69dc5f-7b53-4e00-bf26-7be87d1709d8/tasks' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1460
{
"id" : 1,
"contextKey" : {
"id" : 232
},
"sharing" : "MEMBERS",
"memberPermission" : 8,
"attachmentCount" : 0,
"commentCount" : 0,
"friendlyName" : "Deploy update",
"name" : "deploy_update",
"status" : "WAITING",
"priority" : "MEDIUM",
"progress" : 0,
"author" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"dueDate" : "2022-08-25T11:56:54Z[UTC]",
"tags" : "",
"description" : "Let's do this",
"dateCreated" : 1514764800000,
"dateReminder" : "2017-12-31T08:00Z[UTC]",
"recurrence" : null,
"order" : 2147483647,
"category" : null,
"assignees" : null,
"numberOfSubTasks" : 0,
"lastModified" : 1514764800000,
"timeTracker" : {
"trackingStartDate" : 1514764800000,
"timeTracked" : 948480
},
"dateCompleted" : 1514764810000,
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
}
Path | Type | Description |
---|---|---|
|
|
Task category ID |
|
|
Сontext key |
|
|
Сontext key ID |
|
|
Task slug |
|
|
Task name |
|
|
User created this task |
|
|
Task status code |
|
|
Task priority |
|
|
Task progress |
|
|
Task tags (comma separated) |
|
|
Zoned ISO due date-time |
|
|
Zoned ISO reminder date-time |
|
|
Task recurrence rule |
|
|
Task order |
|
|
Task description |
|
|
File to which the task is attached to |
|
|
Task category |
|
|
Task assignees |
|
|
Sharing option, determines who can see a note: [NONE, DEFAULT, MEMBERS, PUBLIC] |
|
|
Member file permission mask |
|
|
Amount of attachments |
|
|
Amount of comments |
|
|
User is following note |
|
|
Amount of shares |
|
|
Note has individual user permissions |
|
|
User permission |
|
|
Date task was created |
|
|
Date task was completed |
|
|
Date task was last modified |
|
|
Parent task |
|
|
Number of subtasks |
|
|
Task time tracker |
|
|
Tracking start date |
|
|
Time tracked in milliseconds |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User / profile id |
|
|
Group name slug, used for internal identification and URIs |
|
|
Full group name, visible to a user |
|
|
Is commenting disabled for group |
|
|
Group branding settings |
|
|
Header background color |
|
|
Text color |
|
|
Logo exists |
|
|
Logo alignment |
|
|
Background exists |
|
|
Background image X position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Group hash value |
7. Comments
7.1. Comment count
Parameter | Description |
---|---|
|
Share token |
|
Context "name_id". Supported names are: file, page, event, task, discussion |
HTTP/1.1 200 OK
X-Count: 7
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
7.2. List comments
Parameter | Description |
---|---|
|
Share token |
|
Context "name_id". Supported names are: file, page, event, task, discussion |
GET /v3/shares/9bdcd902-3687-42ad-9f82-27d17c9f9157/context/discussion_1/comments HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/9bdcd902-3687-42ad-9f82-27d17c9f9157/context/discussion_1/comments' \
'Content-Type:application/json' \
'Accept:application/json' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/9bdcd902-3687-42ad-9f82-27d17c9f9157/context/discussion_1/comments' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>'
Parameter | Description |
---|---|
|
Parent comment id |
|
Comment offset |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 918
{
"offset" : "0",
"items" : [ {
"comment" : {
"id" : 1,
"commenter" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"updater" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"comment" : "Hello world",
"dateCreated" : 1514764800000,
"dateUpdated" : 1514764800000,
"numberOfChildren" : 0,
"edited" : false
},
"reactions" : null,
"replies" : null
} ],
"more" : true
}
Path | Type | Description |
---|---|---|
|
|
Comment offset |
|
|
Comments |
|
|
Comment id |
|
|
Comment content |
|
|
Number of children |
|
|
Has been edited |
|
|
User object |
|
|
Username |
|
|
Name |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User that updated the comment |
|
|
User object |
|
|
Username |
|
|
Name |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Date created |
|
|
Date updated |
|
|
Comment reactions |
|
|
Comment replies |
|
|
Is there more results |
7.3. Create comment
Parameter | Description |
---|---|
|
Share token |
|
Context "name_id". Supported names are: file, page, event, task, discussion |
POST /v3/shares/4eee93d4-81b7-49d9-b4f9-5256beda34e6/context/event_1/comments HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 25
{
"message" : "Hello"
}
$ echo '{
"message" : "Hello"
}' | http POST 'https://api.clinked.com/v3/shares/4eee93d4-81b7-49d9-b4f9-5256beda34e6/context/event_1/comments' \
'Content-Type:application/json' \
'Authorization:Bearer <YOUR-TOKEN>' \
'Accept:application/json'
$ curl 'https://api.clinked.com/v3/shares/4eee93d4-81b7-49d9-b4f9-5256beda34e6/context/event_1/comments' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-H 'Accept: application/json' \
-d '{
"message" : "Hello"
}'
Path | Type | Description |
---|---|---|
|
|
Comment text |
|
|
Parent id |
|
|
Mentions |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 429
{
"id" : 13,
"commenter" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"updater" : null,
"comment" : "Hello",
"dateCreated" : 1514764800000,
"dateUpdated" : 1514764800000,
"numberOfChildren" : 0,
"edited" : false
}
Path | Type | Description |
---|---|---|
|
|
Comment id |
|
|
Comment content |
|
|
Number of children |
|
|
Has been edited |
|
|
User object |
|
|
Username |
|
|
Name |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User that updated the comment |
|
|
User object |
|
|
Username |
|
|
Name |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Date created |
|
|
Date updated |
7.4. Update comment
Parameter | Description |
---|---|
|
Share token |
|
Context "name_id". Supported names are: file, page, event, task, discussion |
|
Comment id |
PATCH /v3/shares/9204e185-84e0-4f19-8442-b2151141a12a/context/event_1/comments/1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 25
{
"message" : "Hello"
}
$ echo '{
"message" : "Hello"
}' | http PATCH 'https://api.clinked.com/v3/shares/9204e185-84e0-4f19-8442-b2151141a12a/context/event_1/comments/1' \
'Content-Type:application/json' \
'Authorization:Bearer <YOUR-TOKEN>' \
'Accept:application/json'
$ curl 'https://api.clinked.com/v3/shares/9204e185-84e0-4f19-8442-b2151141a12a/context/event_1/comments/1' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-H 'Accept: application/json' \
-d '{
"message" : "Hello"
}'
Path | Type | Description |
---|---|---|
|
|
Comment text |
|
|
Parent id |
|
|
Mentions |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 354
{
"id" : 13,
"commenter" : {
"user" : null,
"name" : "example@example.com",
"username" : null
},
"updater" : {
"user" : null,
"name" : "example@example.com",
"username" : null
},
"comment" : "Hello world",
"dateCreated" : 1514764800000,
"dateUpdated" : 1514764800000,
"numberOfChildren" : 0,
"edited" : false
}
Path | Type | Description |
---|---|---|
|
|
Comment id |
|
|
Commenter object |
|
|
Commenter user object |
|
|
Commenter name |
|
|
Commenter username |
|
|
Comment content |
|
|
Date created |
|
|
Date updated |
|
|
Number of children |
|
|
Has been edited |
|
|
Commenter object |
|
|
Commenter user object |
|
|
Commenter name |
|
|
Commenter username |
7.5. List reactions
Parameter | Description |
---|---|
|
example: reply_1, comment_1, discussions have 'reply', everything else 'comment' |
|
Share token |
GET /v3/shares/ee95f6b6-a23c-4af9-abcd-d601e8b1d2a3/context/comment_1/reactions HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/ee95f6b6-a23c-4af9-abcd-d601e8b1d2a3/context/comment_1/reactions' \
'Content-Type:application/json' \
'Authorization:Bearer <YOUR-TOKEN>' \
'Accept:application/json'
$ curl 'https://api.clinked.com/v3/shares/ee95f6b6-a23c-4af9-abcd-d601e8b1d2a3/context/comment_1/reactions' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-H 'Accept: application/json'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 380
[ {
"user" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"reactionType" : "THUMBS_UP",
"dateCreated" : 1514764800000,
"dateUpdated" : 1514764800000,
"disabled" : false
} ]
Path | Type | Description |
---|---|---|
|
|
User |
|
|
Commenter user object |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Commenter name |
|
|
Commenter username |
|
|
Reaction type: [THUMBS_UP, THUMBS_DOWN, HEART, OPEN_EYE, FIRE] |
|
|
Date created |
|
|
Date updated |
|
|
Is reaction disabled |
7.6. Summary
Parameter | Description |
---|---|
|
example: reply_1, comment_1, discussions have 'reply', everything else 'comment' |
|
Share token |
GET /v3/shares/fb652ac6-6a9b-4591-83ef-318cbcf4ff99/context/comment_1/reactions?summary=&summary= HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/fb652ac6-6a9b-4591-83ef-318cbcf4ff99/context/comment_1/reactions?summary=&summary=' \
'Content-Type:application/json' \
'Authorization:Bearer <YOUR-TOKEN>' \
'Accept:application/json'
$ curl 'https://api.clinked.com/v3/shares/fb652ac6-6a9b-4591-83ef-318cbcf4ff99/context/comment_1/reactions?summary=&summary=' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-H 'Accept: application/json'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 137
{
"totalReactions" : 5,
"userReaction" : "FIRE",
"thumbsUp" : 1,
"thumbsDown" : 1,
"heart" : 1,
"openEye" : 1,
"fire" : 1
}
Path | Type | Description |
---|---|---|
|
|
Number of total reactions |
|
|
Reaction - [THUMBS_UP, THUMBS_DOWN, HEART, OPEN_EYE, FIRE] |
|
|
Number of thumbs up |
|
|
Number of thumbs down |
|
|
Number of hearts |
|
|
Number of open eye |
|
|
Number of fire |
7.7. Create reaction
Parameter | Description |
---|---|
|
example: reply_1, comment_1, discussions have 'reply', everything else 'comment' |
|
Share token |
POST /v3/shares/f410c304-1338-4a92-8bea-5e9f7755b992/context/comment_1/reactions HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
Content-Length: 34
{
"reactionType" : "THUMBS_UP"
}
$ echo '{
"reactionType" : "THUMBS_UP"
}' | http POST 'https://api.clinked.com/v3/shares/f410c304-1338-4a92-8bea-5e9f7755b992/context/comment_1/reactions' \
'Content-Type:application/json' \
'Authorization:Bearer <YOUR-TOKEN>' \
'Accept:application/json'
$ curl 'https://api.clinked.com/v3/shares/f410c304-1338-4a92-8bea-5e9f7755b992/context/comment_1/reactions' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-H 'Accept: application/json' \
-d '{
"reactionType" : "THUMBS_UP"
}'
Path | Type | Description |
---|---|---|
|
|
Reaction type - [THUMBS_UP, THUMBS_DOWN, HEART, OPEN_EYE, FIRE] |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 376
{
"user" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"reactionType" : "THUMBS_UP",
"dateCreated" : 1514764800000,
"dateUpdated" : 1514764800000,
"disabled" : false
}
Path | Type | Description |
---|---|---|
|
|
User |
|
|
Commenter user object |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
Commenter name |
|
|
Commenter username |
|
|
Reaction type: [THUMBS_UP, THUMBS_DOWN, HEART, OPEN_EYE, FIRE] |
|
|
Date created |
|
|
Date updated |
|
|
Is reaction disabled |
7.8. Disable reaction
Parameter | Description |
---|---|
|
example: reply_1, comment_1, discussions have 'reply', everything else 'comment' |
|
Share token |
DELETE /v3/shares/5a983484-8f3f-4885-8a27-7a53eab00e93/context/comment_1/reactions HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com
$ http DELETE 'https://api.clinked.com/v3/shares/5a983484-8f3f-4885-8a27-7a53eab00e93/context/comment_1/reactions' \
'Content-Type:application/json' \
'Authorization:Bearer <YOUR-TOKEN>' \
'Accept:application/json'
$ curl 'https://api.clinked.com/v3/shares/5a983484-8f3f-4885-8a27-7a53eab00e93/context/comment_1/reactions' -i -X DELETE \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-H 'Accept: application/json'
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
8. Attachments
8.1. List attachments
Parameter | Description |
---|---|
|
Share token |
|
Context "name_id". Supported names are: file, page, event, task, discussion |
GET /v3/shares/db2184e3-4c7b-4699-bfdc-63c9dde9aaf3/context/page_1/attachments HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/db2184e3-4c7b-4699-bfdc-63c9dde9aaf3/context/page_1/attachments' \
'Content-Type:application/json' \
'Accept:application/json' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/db2184e3-4c7b-4699-bfdc-63c9dde9aaf3/context/page_1/attachments' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>'
Parameter | Description |
---|---|
|
Page number |
|
Boolean, get only folders |
|
Attachment name |
|
Filter by content type |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 374
{
"items" : [ {
"id" : 1,
"friendlyName" : "Cat.jpg",
"name" : "cat.jpg",
"contentType" : "image/jpg",
"size" : 4500,
"lastModified" : 1749197471027,
"href" : null,
"fileId" : null,
"removed" : false
} ],
"currentPage" : 1,
"totalPages" : 1,
"pageSize" : 1,
"totalResults" : 1,
"nextPage" : false,
"previousPage" : false
}
Path | Type | Description |
---|---|---|
|
|
Attachment id |
|
|
Attachment name |
|
|
Attachment slug |
|
|
Attachment content type |
|
|
Attachment file size |
|
|
Last modification date |
|
|
Preview details |
|
|
Attached group file is removed |
|
|
Linked group file ID |
|
|
Has the preview conversion finished |
|
|
Was the preview conversion successful |
|
|
Values specific to the preview type |
|
|
File URL |
|
|
File ID |
|
|
Error code if preview conversion failed |
|
|
Page items |
|
|
Current page number |
|
|
Current page size |
|
|
Next page available |
|
|
Previous page available |
|
|
Amount of available pages |
|
|
Total results |
8.2. Download attachment
Parameter | Description |
---|---|
|
Share token |
|
Context "name_id". Supported names are: file, page, event, task, discussion |
|
Attachment id |
GET /v3/shares/6942c8ac-98b1-4da8-9ee7-453063734cca/context/page_1/attachments/1/download HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/6942c8ac-98b1-4da8-9ee7-453063734cca/context/page_1/attachments/1/download' \
'Content-Type:application/json' \
'Accept:application/json' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/6942c8ac-98b1-4da8-9ee7-453063734cca/context/page_1/attachments/1/download' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 302 Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: example.com
9. Group files list
9.1. List files
Parameter | Description |
---|---|
|
Share token |
GET /v3/shares/715cb39d-34c1-4533-9afa-8f1dff705106/fileList?page=1&size=5 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/715cb39d-34c1-4533-9afa-8f1dff705106/fileList?page=1&size=5' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/715cb39d-34c1-4533-9afa-8f1dff705106/fileList?page=1&size=5' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
Parameter | Description |
---|---|
|
Page number to load |
|
Page size |
|
Order field |
|
Ascending order direction |
|
Additional data to load |
|
Name filter/search |
|
Parent folder id |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 2949
{
"items" : [ {
"id" : 1,
"contextKey" : {
"id" : 479
},
"sharing" : "NONE",
"memberPermission" : 2,
"following" : null,
"attachmentCount" : 0,
"commentCount" : 0,
"name" : "example_folder",
"friendlyName" : "Example Folder",
"contentType" : "@folder",
"size" : 0,
"uploaded" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"tags" : null,
"locked" : false,
"locker" : null,
"lastModified" : 1514764800000,
"summary" : null,
"path" : [ ],
"versions" : 0,
"previewInfo" : null,
"watermark" : false,
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
}, {
"id" : 1,
"contextKey" : {
"id" : 734
},
"sharing" : "NONE",
"memberPermission" : 2,
"following" : null,
"attachmentCount" : 0,
"commentCount" : 0,
"name" : "file_example.pdf",
"friendlyName" : "File Example.pdf",
"contentType" : "application/pdf",
"size" : 1000,
"uploaded" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"tags" : "tag1,tag2",
"locked" : false,
"locker" : null,
"lastModified" : 1514764800000,
"summary" : null,
"path" : [ ],
"versions" : 0,
"previewInfo" : null,
"watermark" : false,
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
} ],
"currentPage" : 1,
"pageSize" : 5,
"totalResults" : 0,
"nextPage" : false,
"previousPage" : false
}
Path | Type | Description |
---|---|---|
|
|
Page items |
|
|
Current page number |
|
|
Current page size |
|
|
Next page available |
|
|
Previous page available |
|
|
Amount of available pages |
|
|
Total results |
|
|
File id |
|
|
Context key |
|
|
Context key ID |
|
|
Base information about the group |
|
|
Unique file name, generated automatically by API |
|
|
Full file name that should be visible to a user |
|
|
Content type |
|
|
Size in bytes |
|
|
User who uploaded a file |
|
|
Number of versions |
|
|
Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC] |
|
|
Member file permission mask |
|
|
Tags separated by comma |
|
|
File is locked and should not be updated |
|
|
User locked the file |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Preview data if available |
|
|
Array of all file records making up the path of this file (incl. itself) |
|
|
File parent folder |
|
|
Latest file version comment |
|
|
Indicates that user is following the file record or not |
|
|
Amount of comments |
|
|
Amount of attachments |
|
|
File watermark status |
|
|
User’s full name |
|
|
Detailed user data, will be set to null if user is deleted |
|
|
User username if user is defined |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User / profile id |
|
|
Group name slug, used for internal identification and URIs |
|
|
Full group name, visible to a user |
|
|
Is commenting disabled for group |
|
|
Group branding settings |
|
|
Header background color |
|
|
Text color |
|
|
Logo exists |
|
|
Logo alignment |
|
|
Background exists |
|
|
Background image X position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Group hash value |
10. Files batch download
10.1. Submit download request
Parameter | Description |
---|---|
|
Share token |
POST /v3/shares/b9b3251c-f3ee-4ec1-b818-9e32fda4179b/filesBatchDownload HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
Content-Length: 5
[ 1 ]
$ echo '[ 1 ]' | http POST 'https://api.clinked.com/v3/shares/b9b3251c-f3ee-4ec1-b818-9e32fda4179b/filesBatchDownload' \
'Content-Type:application/json' \
'Accept:application/json' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/b9b3251c-f3ee-4ec1-b818-9e32fda4179b/filesBatchDownload' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-d '[ 1 ]'
Path | Type | Description |
---|---|---|
|
|
Array of file id’s |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 38
"0a6dc47d-34b4-4800-90b4-aab748d402e8"
Description |
---|
Download Job id |
10.2. Job status
Parameter | Description |
---|---|
|
Share token |
|
Download job id |
GET /v3/shares/9932f22b-f56a-4367-91c1-ce4022c60dfb/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4/status HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/9932f22b-f56a-4367-91c1-ce4022c60dfb/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4/status' \
'Content-Type:application/json' \
'Accept:application/json' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/9932f22b-f56a-4367-91c1-ce4022c60dfb/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4/status' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
HTTP/1.1 206 Partial Content
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 41
{
"complete" : 999,
"total" : 10000
}
Path | Type | Description |
---|---|---|
|
|
Completed bytes |
|
|
Total bytes |
10.3. Download Files
Parameter | Description |
---|---|
|
Share token |
|
Download job id |
GET /v3/shares/5cee9c3e-d6c5-4fa5-a745-2993f245a08e/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4 HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/5cee9c3e-d6c5-4fa5-a745-2993f245a08e/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4' \
'Content-Type:application/json' \
'Accept:application/json' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/5cee9c3e-d6c5-4fa5-a745-2993f245a08e/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 302 Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: http://url-to-transfer-101
11. Files
11.1. Files search
Parameter | Description |
---|---|
|
Share token |
GET /v3/shares/74876efa-4297-46ae-9988-39d5c39e8847/files?path=file_example.pdf HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/74876efa-4297-46ae-9988-39d5c39e8847/files?path=file_example.pdf' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/74876efa-4297-46ae-9988-39d5c39e8847/files?path=file_example.pdf' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
Parameter | Description |
---|---|
|
File path |
|
Set of file id’s |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1308
{
"id" : 1,
"contextKey" : {
"id" : 564
},
"sharing" : "NONE",
"memberPermission" : 2,
"following" : null,
"attachmentCount" : 0,
"commentCount" : 0,
"name" : "file_example.pdf",
"friendlyName" : "File Example.pdf",
"contentType" : "application/pdf",
"size" : 1000,
"uploaded" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"tags" : "tag1,tag2",
"locked" : false,
"locker" : null,
"lastModified" : 1514764800000,
"summary" : null,
"path" : [ ],
"versions" : 0,
"previewInfo" : null,
"watermark" : false,
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
}
Path | Type | Description |
---|---|---|
|
|
File id |
|
|
Context key |
|
|
Context key ID |
|
|
Base information about the group |
|
|
Unique file name, generated automatically by API |
|
|
Full file name that should be visible to a user |
|
|
Content type |
|
|
Size in bytes |
|
|
User who uploaded a file |
|
|
Number of versions |
|
|
Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC] |
|
|
Member file permission mask |
|
|
Tags separated by comma |
|
|
File is locked and should not be updated |
|
|
User locked the file |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Preview data if available |
|
|
Array of all file records making up the path of this file (incl. itself) |
|
|
File parent folder |
|
|
Latest file version comment |
|
|
Indicates that user is following the file record or not |
|
|
Amount of comments |
|
|
Amount of attachments |
|
|
File watermark status |
|
|
User’s full name |
|
|
Detailed user data, will be set to null if user is deleted |
|
|
User username if user is defined |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User / profile id |
|
|
Group name slug, used for internal identification and URIs |
|
|
Full group name, visible to a user |
|
|
Is commenting disabled for group |
|
|
Group branding settings |
|
|
Header background color |
|
|
Text color |
|
|
Logo exists |
|
|
Logo alignment |
|
|
Background exists |
|
|
Background image X position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Group hash value |
11.2. File details
Returns detailed information about a single file.
Parameter | Description |
---|---|
|
Share token |
|
File id |
GET /v3/shares/1ff80990-94cb-4fe1-ab01-c78ac13250d3/files/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/1ff80990-94cb-4fe1-ab01-c78ac13250d3/files/1' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/1ff80990-94cb-4fe1-ab01-c78ac13250d3/files/1' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1308
{
"id" : 1,
"contextKey" : {
"id" : 398
},
"sharing" : "NONE",
"memberPermission" : 2,
"following" : null,
"attachmentCount" : 0,
"commentCount" : 0,
"name" : "file_example.pdf",
"friendlyName" : "File Example.pdf",
"contentType" : "application/pdf",
"size" : 1000,
"uploaded" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"tags" : "tag1,tag2",
"locked" : false,
"locker" : null,
"lastModified" : 1514764800000,
"summary" : null,
"path" : [ ],
"versions" : 0,
"previewInfo" : null,
"watermark" : false,
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
}
Path | Type | Description |
---|---|---|
|
|
File id |
|
|
Context key |
|
|
Context key ID |
|
|
Base information about the group |
|
|
Unique file name, generated automatically by API |
|
|
Full file name that should be visible to a user |
|
|
Content type |
|
|
Size in bytes |
|
|
User who uploaded a file |
|
|
Number of versions |
|
|
Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC] |
|
|
Member file permission mask |
|
|
Tags separated by comma |
|
|
File is locked and should not be updated |
|
|
User locked the file |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Preview data if available |
|
|
Array of all file records making up the path of this file (incl. itself) |
|
|
File parent folder |
|
|
Latest file version comment |
|
|
Indicates that user is following the file record or not |
|
|
Amount of comments |
|
|
Amount of attachments |
|
|
File watermark status |
|
|
User’s full name |
|
|
Detailed user data, will be set to null if user is deleted |
|
|
User username if user is defined |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User / profile id |
|
|
Group name slug, used for internal identification and URIs |
|
|
Full group name, visible to a user |
|
|
Is commenting disabled for group |
|
|
Group branding settings |
|
|
Header background color |
|
|
Text color |
|
|
Logo exists |
|
|
Logo alignment |
|
|
Background exists |
|
|
Background image X position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Group hash value |
11.3. File Preview
Parameter | Description |
---|---|
|
Share token |
|
File id |
GET /v3/shares/4c0bb07e-f396-4d46-ad20-eed4902b545a/files/1/preview?path=file_example.pdf HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/4c0bb07e-f396-4d46-ad20-eed4902b545a/files/1/preview?path=file_example.pdf' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/4c0bb07e-f396-4d46-ad20-eed4902b545a/files/1/preview?path=file_example.pdf' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 389
{
"session" : {
"id" : "3123123-kjhgkjhg",
"dateCreated" : "2023-06-29T11:55:40.851Z",
"dateExpire" : "2023-06-29T12:25:40.851Z",
"data" : {
"print" : true,
"annotate" : true,
"user" : {
"name" : "Jack Bauer",
"id" : 1
}
}
},
"url" : "example.com",
"websocketUrl" : "wss:example.com",
"embedUrl" : "example.com/embed"
}
Path | Type | Description |
---|---|---|
|
|
Session |
|
|
Session id |
|
|
Date created |
|
|
Date expire |
|
|
Has write permission |
|
|
Are comments not disabled |
|
|
User |
|
|
User id |
|
|
User name |
|
|
Preview url |
|
|
Websocket url |
|
|
Embed url |
11.4. Thumbnail
Download file thumbnail if it has one, otherwise default thumbnail gets returned.
Parameter | Description |
---|---|
|
Share token |
|
File id |
GET /v3/shares/223b7806-3630-4f88-9851-0356ba6526bb/files/1/thumbnail?path=file_example.pdf HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/223b7806-3630-4f88-9851-0356ba6526bb/files/1/thumbnail?path=file_example.pdf' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/223b7806-3630-4f88-9851-0356ba6526bb/files/1/thumbnail?path=file_example.pdf' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
Content-Disposition: inline; filename="filename"
Last-Modified: Mon, 01 Jan 2018 00:00:00 GMT
Content-Length: 4623
Content-Type: image/png
Accept-Ranges: bytes
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
11.5. Download file
Parameter | Description |
---|---|
|
Share token |
|
File id |
GET /v3/shares/4435e709-31df-4fb3-b58d-947fb09349dd/files/1/download?path=file_example.pdf HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/4435e709-31df-4fb3-b58d-947fb09349dd/files/1/download?path=file_example.pdf' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/4435e709-31df-4fb3-b58d-947fb09349dd/files/1/download?path=file_example.pdf' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 302 Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: example.com
11.6. Create file
For more information see Uploading files.
Parameter | Description |
---|---|
|
Share token |
|
File id |
POST /v3/shares/670a35a0-47d3-4cb8-a644-fb354ea3964e/files/1?path=file_example.pdf HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
Content-Length: 123
{
"friendlyName" : "FileName",
"memberPermission" : 8,
"sharing" : "MEMBERS",
"versionSummary" : "Inital version"
}
$ echo '{
"friendlyName" : "FileName",
"memberPermission" : 8,
"sharing" : "MEMBERS",
"versionSummary" : "Inital version"
}' | http POST 'https://api.clinked.com/v3/shares/670a35a0-47d3-4cb8-a644-fb354ea3964e/files/1?path=file_example.pdf' \
'Content-Type:application/json' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/670a35a0-47d3-4cb8-a644-fb354ea3964e/files/1?path=file_example.pdf' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-d '{
"friendlyName" : "FileName",
"memberPermission" : 8,
"sharing" : "MEMBERS",
"versionSummary" : "Inital version"
}'
Path | Type | Description |
---|---|---|
|
|
Full file name |
|
|
Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC] |
|
|
Member file permission mask |
|
|
Version summary text |
|
|
Temp file id |
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1276
{
"id" : 5,
"contextKey" : {
"id" : 15
},
"sharing" : "MEMBERS",
"memberPermission" : 8,
"following" : null,
"attachmentCount" : 0,
"commentCount" : 0,
"name" : "filename",
"friendlyName" : "FileName",
"contentType" : "@folder",
"size" : 0,
"uploaded" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"tags" : null,
"locked" : false,
"locker" : null,
"lastModified" : 1749197468818,
"summary" : null,
"path" : [ ],
"versions" : 0,
"previewInfo" : null,
"watermark" : false,
"group" : {
"id" : 1,
"name" : "explore_clinked",
"friendlyName" : "Explore Clinked",
"disableComments" : false,
"branding" : {
"headerColor" : "#ffffff",
"textColor" : "#ff0000",
"logo" : false,
"background" : false,
"alignment" : "left",
"backgroundPositionX" : 50,
"backgroundPositionY" : 50,
"hideBackgroundGradient" : false,
"hideLogoBackground" : false,
"hideGroupName" : false,
"hideLogo" : false
},
"lastModified" : 1514764800000,
"hash" : null
}
}
Path | Type | Description |
---|---|---|
|
|
File id |
|
|
Context key |
|
|
Context key ID |
|
|
Base information about the group |
|
|
Unique file name, generated automatically by API |
|
|
Full file name that should be visible to a user |
|
|
Content type |
|
|
Size in bytes |
|
|
User who uploaded a file |
|
|
Number of versions |
|
|
Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC] |
|
|
Member file permission mask |
|
|
Tags separated by comma |
|
|
File is locked and should not be updated |
|
|
User locked the file |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Preview data if available |
|
|
Array of all file records making up the path of this file (incl. itself) |
|
|
File parent folder |
|
|
Latest file version comment |
|
|
Indicates that user is following the file record or not |
|
|
Amount of comments |
|
|
Amount of attachments |
|
|
File watermark status |
|
|
User’s full name |
|
|
Detailed user data, will be set to null if user is deleted |
|
|
User username if user is defined |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User / profile id |
|
|
Group name slug, used for internal identification and URIs |
|
|
Full group name, visible to a user |
|
|
Is commenting disabled for group |
|
|
Group branding settings |
|
|
Header background color |
|
|
Text color |
|
|
Logo exists |
|
|
Logo alignment |
|
|
Background exists |
|
|
Background image X position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Background image Y position |
|
|
Last modification date (timestamp in milliseconds) |
|
|
Group hash value |
11.8. List versions
Parameter | Description |
---|---|
|
Share token |
|
File id |
GET /v3/shares/745f8c4c-87ff-4e03-a075-6a2be141c007/files/1/versions?page=1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/745f8c4c-87ff-4e03-a075-6a2be141c007/files/1/versions?page=1' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/745f8c4c-87ff-4e03-a075-6a2be141c007/files/1/versions?page=1' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
Parameter | Description |
---|---|
|
Page number |
Path | Type | Description |
---|---|---|
|
|
ID |
|
|
Version number |
|
|
A safe user who uploaded a file |
|
|
Version description / summary |
|
|
Last modification timestamp |
|
|
Size in bytes |
|
|
User’s full name |
|
|
User’s usernae if the user is defined |
|
|
Detailed user data, will be set to null if user is deleted |
|
|
User / profile id |
|
|
Full name |
|
|
Username |
|
|
Avatar available |
|
|
Job title |
|
|
Last profile update date |
|
|
Page items |
|
|
Current page number |
|
|
Current page size |
|
|
Next page available |
|
|
Previous page available |
|
|
Amount of available pages |
|
|
Total results |
11.9. Download version
Parameter | Description |
---|---|
|
Share token |
|
File id |
|
Version id |
GET /v3/shares/dc46f143-a295-4d0e-9c7a-667ec4b6f0c2/files/1/versions/2?page=1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/dc46f143-a295-4d0e-9c7a-667ec4b6f0c2/files/1/versions/2?page=1' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/dc46f143-a295-4d0e-9c7a-667ec4b6f0c2/files/1/versions/2?page=1' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 302 Found
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Location: example.com
11.11. List approval requests
Parameter | Description |
---|---|
|
Share token |
|
File id |
GET /v3/shares/1e94cda2-d0cf-4fb1-a2d4-52f2ef20e5b7/files/1/approvals HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
$ http GET 'https://api.clinked.com/v3/shares/1e94cda2-d0cf-4fb1-a2d4-52f2ef20e5b7/files/1/approvals' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/1e94cda2-d0cf-4fb1-a2d4-52f2ef20e5b7/files/1/approvals' -i -X GET \
-H 'Authorization: Bearer <YOUR-TOKEN>'
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1604
{
"items" : [ {
"version" : {
"id" : 1,
"versionNumber" : 1,
"uploaded" : {
"user" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"name" : "Jack Bauer",
"username" : "jack"
},
"summary" : "Initial version",
"lastModified" : 1749197467988,
"size" : 1024
},
"requests" : [ {
"id" : 1,
"contextKey" : {
"id" : 103
},
"source" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"target" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"container" : {
"id" : 1,
"contextKey" : {
"id" : 586
},
"type" : "group"
},
"sourceName" : "jack.bauer@clinked.com",
"targetName" : "jack.bauer@clinked.com",
"type" : "ACCEPT_DECLINE",
"status" : "NONE",
"scope" : "1",
"parameters" : null,
"lastModified" : 1749197467988,
"account" : {
"id" : 1,
"name" : "awesome_org",
"friendlyName" : "Awesome Organisation",
"enabled" : true
}
} ]
} ],
"currentPage" : 1,
"pageSize" : 5,
"nextPage" : false,
"previousPage" : false
}
Path | Type | Description |
---|---|---|
|
|
Page items |
|
|
Current page number |
|
|
Current page size |
|
|
Next page available |
|
|
Previous page available |
|
|
Amount of available pages |
|
|
Total results |
|
|
File version |
|
|
List of requests |
|
|
ID |
|
|
Version number |
|
|
A safe user who uploaded a file |
|
|
Version description / summary |
|
|
Last modification timestamp |
|
|
Size in bytes |
|
|
User’s full name |
|
|
User’s usernae if the user is defined |
|
|
Detailed user data, will be set to null if user is deleted |
|
|
User / profile id |
|
|
Full name |
|
|
Username |
|
|
Avatar available |
|
|
Job title |
|
|
Last profile update date |
|
|
Entity id |
|
|
Context key |
|
|
Context key ID |
|
|
User who created a request |
|
|
Target user |
|
|
Request container |
|
|
Source user name |
|
|
Target user name |
|
|
Request type |
|
|
Request status |
|
|
Scope |
|
|
Additional parameters |
|
|
Last modification date |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User / profile id |
|
|
Account name slug, used for internal identification and URIs |
|
|
Full account name, visible to a user |
|
|
Is account enabled |
11.12. Update approval request
Parameter | Description |
---|---|
|
Share token |
|
File id |
|
Request id |
PATCH /v3/shares/238274c4-74f8-4de6-9d82-f474d4a391b0/files/1/approvals/2 HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
Content-Length: 54
{
"status" : "ACCEPT",
"parameters" : "Approved"
}
$ echo '{
"status" : "ACCEPT",
"parameters" : "Approved"
}' | http PATCH 'https://api.clinked.com/v3/shares/238274c4-74f8-4de6-9d82-f474d4a391b0/files/1/approvals/2' \
'Content-Type:application/json' \
'Authorization:Bearer <YOUR-TOKEN>'
$ curl 'https://api.clinked.com/v3/shares/238274c4-74f8-4de6-9d82-f474d4a391b0/files/1/approvals/2' -i -X PATCH \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR-TOKEN>' \
-d '{
"status" : "ACCEPT",
"parameters" : "Approved"
}'
Path | Type | Description |
---|---|---|
|
|
Approval status - [NONE, ACCEPT, DECLINE, MAYBE, REJECT] |
|
|
Approval message |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 820
{
"id" : 2,
"contextKey" : {
"id" : 131
},
"source" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"target" : {
"id" : 1,
"name" : "Jack Bauer",
"username" : "jack",
"logo" : false,
"jobTitle" : "Marketing",
"lastModified" : 1514764800000
},
"container" : {
"id" : 1,
"contextKey" : {
"id" : 516
},
"type" : "group"
},
"sourceName" : "guest@test.me",
"targetName" : "guest@test.me",
"type" : "FILE_APPROVAL",
"status" : "ACCEPT",
"scope" : "1",
"parameters" : null,
"lastModified" : 1749197467897,
"account" : {
"id" : 1,
"name" : "awesome_org",
"friendlyName" : "Awesome Organisation",
"enabled" : true
}
}
Path | Type | Description |
---|---|---|
|
|
Entity id |
|
|
Context key |
|
|
Context key ID |
|
|
User who created a request |
|
|
Target user |
|
|
Request container |
|
|
Source user name |
|
|
Target user name |
|
|
Request type |
|
|
Request status |
|
|
Scope |
|
|
Additional parameters |
|
|
Last modification date |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User id |
|
|
Full name |
|
|
Username |
|
|
Profile picture is defined |
|
|
Job title |
|
|
Last modified date |
|
|
User / profile id |
|
|
Account name slug, used for internal identification and URIs |
|
|
Full account name, visible to a user |
|
|
Is account enabled |
Comment reactions are user-generated responses to comments in the portal.