Clinked REST API Documentation

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

HTTP

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

Parameter	Description
`client_id`	Client id for guest should be - clinked-guests
`grant_type`	Grant type for guest should be - share
`token`	Share token

client_id

Client id for guest should be - clinked-guests

grant_type

Grant type for guest should be - share

token

Share token

2. Guest shares

2.1. List shared content

HTTP

GET /v3/shares HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares' \
    'Content-Type:application/json' \
    'Accept:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Example of a success response

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" : 537
  },
  "dateCreated" : 1514764800000,
  "dateExpire" : null,
  "email" : "email@example.com",
  "tokenKey" : "1febce4a-9da1-4e3f-998a-9cc16d4fc376",
  "permission" : 1,
  "passwordEnabled" : false,
  "notifications" : false,
  "component" : {
    "id" : 1,
    "contextKey" : {
      "id" : 561
    },
    "type" : "page",
    "name" : "home_page",
    "friendlyName" : "Home Page"
  }
} ]

Table 1. Definition of the returned fields
Path	Type	Description
`[]user`	`Object`	Optional user
`[]user.id`	`Number`	User id
`[]user.name`	`String`	Full name
`[]user.username`	`String`	Username
`[]user.logo`	`Boolean`	Profile picture is defined
`[]user.jobTitle`	`String`	Job title
`[]user.lastModified`	`Number`	Last modified date
`[]contentContext.id`	`Number`	Content context id
`[]dateCreated`	`Number`	Date created
`[]dateExpire`	`Number`	Date expired
`[]email`	`String`	Guest email
`[]tokenKey`	`String`	Token key
`[]permission`	`Number`	Permission
`[]passwordEnabled`	`Boolean`	Permission
`[]notifications`	`Boolean`	Notifications enabled
`[]component`	`Object`	Shared component
`[]component.id`	`Number`	Component id
`[]component.contextKey.id`	`Number`	Context key id
`[]component.type`	`String`	Component type - discussion, page, event, file, page, task
`[]component.name`	`String`	Component name
`[]component.friendlyName`	`String`	Component friendly name

2.2. Get shared content

Table 2. /v3/shares/{shareToken}
Parameter	Description
`shareToken`	Share token

HTTP

GET /v3/shares/f09bc859-936c-4f1f-8b14-a4b74c42c127 HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/f09bc859-936c-4f1f-8b14-a4b74c42c127' \
    'Content-Type:application/json' \
    'Accept:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/f09bc859-936c-4f1f-8b14-a4b74c42c127' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Example of a success response

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: 433

{
  "user" : {
    "id" : 1,
    "name" : "Jack Bauer",
    "username" : "jack",
    "logo" : false,
    "jobTitle" : "Marketing",
    "lastModified" : 1514764800000
  },
  "contentContext" : {
    "id" : 96
  },
  "dateCreated" : 1514764800000,
  "dateExpire" : null,
  "email" : "email@example.com",
  "tokenKey" : "f09bc859-936c-4f1f-8b14-a4b74c42c127",
  "permission" : 1,
  "passwordEnabled" : false,
  "notifications" : false
}

Table 3. Definition of the returned fields
Path	Type	Description
`user`	`Object`	Optional user
`user.id`	`Number`	User id
`user.name`	`String`	Full name
`user.username`	`String`	Username
`user.logo`	`Boolean`	Profile picture is defined
`user.jobTitle`	`String`	Job title
`user.lastModified`	`Number`	Last modified date
`contentContext.id`	`Number`	Content context id
`dateCreated`	`Number`	Date created
`dateExpire`	`Number`	Date expired
`email`	`String`	Guest email
`tokenKey`	`String`	Token key
`permission`	`Number`	Permission
`passwordEnabled`	`Boolean`	Permission
`notifications`	`Boolean`	Notifications enabled

3. Discussions

3.1. Single discussion

Table 4. /v3/shares/{shareToken}/discussion
Parameter	Description
`shareToken`	Share token

HTTP

GET /v3/shares/63ade813-96a2-4317-bd6f-643473429b5f/discussion HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/63ade813-96a2-4317-bd6f-643473429b5f/discussion' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/63ade813-96a2-4317-bd6f-643473429b5f/discussion' -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
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
  }
}

Table 5. Definition of the returned fields
Path	Type	Description
`id`	`Number`	discussion id
`contextKey`	`Object`	Context key
`contextKey.id`	`Number`	Context key ID
`sharing`	`String`	Level of sharing
`memberPermission`	`Number`	Permission level
`name`	`String`	Discussion name
`friendlyName`	`String`	Discussion name
`tags`	`String`	Tags
`description`	`String`	Discussion description
`replies`	`Number`	Reply count
`dateCreated`	`Number`	Date created
`lastModified`	`Number`	Date last modified
`attachmentCount`	`Number`	Attachment count
`author.name`	`String`	User’s full name
`author.user`	`Object`	Detailed user data, will be set to null if user is deleted
`author.username`	`String`	User username if user is defined
`author.user.id`	`Number`	User id
`author.user.name`	`String`	Full name
`author.user.username`	`String`	Username
`author.user.logo`	`Boolean`	Profile picture is defined
`author.user.jobTitle`	`String`	Job title
`author.user.lastModified`	`Number`	Last modified date
`group.id`	`Number`	User / profile id
`group.name`	`String`	Group name slug, used for internal identification and URIs
`group.friendlyName`	`String`	Full group name, visible to a user
`group.disableComments`	`Boolean`	Is commenting disabled for group
`group.branding`	`Object`	Group branding settings
`group.branding.headerColor`	`String`	Header background color
`group.branding.textColor`	`String`	Text color
`group.branding.logo`	`Boolean`	Logo exists
`group.branding.alignment`	`String`	Logo alignment
`group.branding.background`	`Boolean`	Background exists
`group.branding.backgroundPositionX`	`Number`	Background image X position
`group.branding.backgroundPositionY`	`Number`	Background image Y position
`group.branding.hideBackgroundGradient`	`Boolean`	Background image Y position
`group.branding.hideLogoBackground`	`Boolean`	Background image Y position
`group.branding.hideGroupName`	`Boolean`	Background image Y position
`group.branding.hideLogo`	`Boolean`	Background image Y position
`group.lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`group.hash`	`String`	Group hash value

3.2. Discussion replies

3.3. List replies

Table 6. /v3/shares/{shareToken}/discussion/replies
Parameter	Description
`shareToken`	Share token

HTTP

GET /v3/shares/a0ccb06b-dd54-4c6e-b609-0172f5fa5ea3/discussion/replies?page=1&size=10 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/a0ccb06b-dd54-4c6e-b609-0172f5fa5ea3/discussion/replies?page=1&size=10' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/a0ccb06b-dd54-4c6e-b609-0172f5fa5ea3/discussion/replies?page=1&size=10' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Table 7. Request parameters
Parameter	Description
`page`	Page number
`size`	Page size

Example of a success response

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
}

Table 8. Definition of the returned fields
Path	Type	Description
`items`	`Array`	Page items
`currentPage`	`Number`	Current page number
`pageSize`	`Number`	Current page size
`nextPage`	`Boolean`	Next page available
`previousPage`	`Boolean`	Previous page available
`totalPages`	`Number`	Amount of available pages
`totalResults`	`Number`	Total results
`items[].id`	`Number`	Reply id
`items[].reply`	`String`	Reply text
`items[].dateCreated`	`Number`	Date created
`items[].author.name`	`String`	User’s full name
`items[].author.user`	`Object`	Detailed user data, will be set to null if user is deleted
`items[].author.username`	`String`	User username if user is defined
`items[].author.user.id`	`Number`	User id
`items[].author.user.name`	`String`	Full name
`items[].author.user.username`	`String`	Username
`items[].author.user.logo`	`Boolean`	Profile picture is defined
`items[].author.user.jobTitle`	`String`	Job title
`items[].author.user.lastModified`	`Number`	Last modified date
`items[].reactions.totalReactions`	`Number`	Number of total reactions
`items[].reactions.userReaction`	`String`	Reaction - [THUMBS_UP, THUMBS_DOWN, HEART, OPEN_EYE, FIRE]
`items[].reactions.thumbsUp`	`Number`	Number of thumbs up
`items[].reactions.thumbsDown`	`Number`	Number of thumbs down
`items[].reactions.heart`	`Number`	Number of hearts
`items[].reactions.openEye`	`Number`	Number of open eye
`items[].reactions.fire`	`Number`	Number of fire

3.4. Create reply

Table 9. /v3/shares/{shareToken}/discussion/replies
Parameter	Description
`shareToken`	Share token

HTTP

POST /v3/shares/a9624b7a-ecc4-4c47-84c3-46dd9607bbf4/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"
}

HTTPie

$ echo '{
  "reply" : "Hello"
}' | http POST 'https://api.clinked.com/v3/shares/a9624b7a-ecc4-4c47-84c3-46dd9607bbf4/discussion/replies' \
    'Content-Type:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>' \
    'Accept:application/json'

Curl

$ curl 'https://api.clinked.com/v3/shares/a9624b7a-ecc4-4c47-84c3-46dd9607bbf4/discussion/replies' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "reply" : "Hello"
}'

Table 10. Request fields
Path	Type	Description
`reply`	`String`	Reply text

Example of a success response

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
}

Table 11. Definition of the returned fields
Path	Type	Description
`id`	`Number`	Reply id
`reply`	`String`	Reply text
`dateCreated`	`Number`	Date created
`author.name`	`String`	User’s full name
`author.user`	`Object`	Detailed user data, will be set to null if user is deleted
`author.username`	`String`	User username if user is defined
`author.user.id`	`Number`	User id
`author.user.name`	`String`	Full name
`author.user.username`	`String`	Username
`author.user.logo`	`Boolean`	Profile picture is defined
`author.user.jobTitle`	`String`	Job title
`author.user.lastModified`	`Number`	Last modified date
`reactions`	`Object`	Reactions

4. Events

4.1. Single event

Table 12. /v3/shares/{shareToken}/events
Parameter	Description
`shareToken`	Share token

HTTP

GET /v3/shares/1b181178-048d-4100-a0c3-9ca9af040032/events HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/1b181178-048d-4100-a0c3-9ca9af040032/events' \
    'Content-Type:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>' \
    'Accept:application/json'

Curl

$ curl 'https://api.clinked.com/v3/shares/1b181178-048d-4100-a0c3-9ca9af040032/events' -i -X GET \
    -H 'Content-Type: application/json' \
    -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
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" : 629
  },
  "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-04-30T19:53:58.253Z[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
  }
}

Table 13. Definition of the returned fields
Path	Type	Description
`id`	`Number`	Event ID
`contextKey`	`Object`	Context key
`contextKey.id`	`Number`	Context key ID
`sharing`	`String`	Sharing option, determines who can see an event: [NONE, DEFAULT, MEMBERS, PUBLIC]
`memberPermission`	`Number`	Member permission mask
`author`	`Object`	Event author
`attachmentCount`	`Number`	Amount of attachments
`name`	`String`	Unique name
`friendlyName`	`String`	Full name
`startDate`	`String`	Event start date
`endDate`	`String`	Event end date
`allDay`	`Boolean`	All day event
`location`	`String`	Event location
`tags`	`String`	Comma separated list of tags
`dateReminder`	`String`	When to send a reminder about an event
`recurrence`	`String`	Valid recurrence rule
`dateEndRecurrence`	`String`	Recurrence end date
`description`	`String`	Event description
`assignees`	`Array`	List of users invited to the event
`lastModified`	`Number`	Date last modified
`disableMaybe`	`Boolean`	Do not allow invited members to choose 'maybe' option
`commentCount`	`Number`	Comment count
`color`	`String`	Event color
`author.id`	`Number`	User id
`author.name`	`String`	Full name
`author.username`	`String`	Username
`author.logo`	`Boolean`	Profile picture is defined
`author.jobTitle`	`String`	Job title
`author.lastModified`	`Number`	Last modified date
`group.id`	`Number`	User / profile id
`group.name`	`String`	Group name slug, used for internal identification and URIs
`group.friendlyName`	`String`	Full group name, visible to a user
`group.disableComments`	`Boolean`	Is commenting disabled for group
`group.branding`	`Object`	Group branding settings
`group.branding.headerColor`	`String`	Header background color
`group.branding.textColor`	`String`	Text color
`group.branding.logo`	`Boolean`	Logo exists
`group.branding.alignment`	`String`	Logo alignment
`group.branding.background`	`Boolean`	Background exists
`group.branding.backgroundPositionX`	`Number`	Background image X position
`group.branding.backgroundPositionY`	`Number`	Background image Y position
`group.branding.hideBackgroundGradient`	`Boolean`	Background image Y position
`group.branding.hideLogoBackground`	`Boolean`	Background image Y position
`group.branding.hideGroupName`	`Boolean`	Background image Y position
`group.branding.hideLogo`	`Boolean`	Background image Y position
`group.lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`group.hash`	`String`	Group hash value

5. Notes

5.1. Single note

Table 14. /v3/shares/{shareToken}/notes
Parameter	Description
`shareToken`	Share token

HTTP

GET /v3/shares/6b54f111-f5ca-4961-9874-535863dc7178/notes HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/6b54f111-f5ca-4961-9874-535863dc7178/notes' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/6b54f111-f5ca-4961-9874-535863dc7178/notes' -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
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" : 195
  },
  "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
  }
}

Table 15. Definition of the returned fields
Path	Type	Description
`id`	`Number`	Note id
`name`	`String`	Unique name (slug)
`friendlyName`	`String`	Name
`contextKey`	`Object`	Context key
`contextKey.id`	`Number`	Context key ID
`group`	`Object`	Base details about group
`template`	`Boolean`	Is a template
`tags`	`String`	Comma-separated list of tags
`content`	`String`	Note content
`sharing`	`String`	Sharing option, determines who can see a note: [NONE, DEFAULT, MEMBERS, PUBLIC]
`memberPermission`	`Number`	Member file permission mask
`attachmentCount`	`Number`	Amount of attachments
`commentCount`	`Number`	Amount of comments
`attachments`	`Array`	List of attachments
`creator`	`Object`	User created the page
`lastModified`	`Number`	Date when note was last modified
`versions`	`Number`	Total page vesions
`dateCreated`	`Number`	Date when note was created
`pageType`	`String`	PAGE or FOLDER
`creator.id`	`Number`	User id
`creator.name`	`String`	Full name
`creator.username`	`String`	Username
`creator.logo`	`Boolean`	Profile picture is defined
`creator.jobTitle`	`String`	Job title
`creator.lastModified`	`Number`	Last modified date
`creator.enabled`	`Boolean`	Is user enabled
`creator.locked`	`Boolean`	Is user locked
`creator.organisation`	`String`	Organisation name
`creator.email`	`String`	Email address
`creator.address`	`String`	Address
`creator.telephone`	`String`	Phone number
`creator.other`	`String`	Optional other information
`creator.timeZone`	`String`	Time zone ID
`creator.locale`	`String`	Locale
`creator.verifiedEmail`	`Boolean`	Is email verified
`creator.twoFactorAuthentication`	`Boolean`	Is 2FA enabled
`creator.twoFactorMode`	`String`	2FA mode: [AUTHENTICATOR, SMS, EMAIL]
`creator.twentyFourHourTimeFormat`	`Boolean`	Time format preference - 24hr or 12hr format
`creator.lastActive`	`Number`	Date the user was last active
`creator.dateFormat`	`Boolean`	Date format preference - YMD (Year-Month-Day), MDY (Month/Day/Year) or DMY(Day/Month/Year)
`group.id`	`Number`	User / profile id
`group.name`	`String`	Group name slug, used for internal identification and URIs
`group.friendlyName`	`String`	Full group name, visible to a user
`group.disableComments`	`Boolean`	Is commenting disabled for group
`group.branding`	`Object`	Group branding settings
`group.branding.headerColor`	`String`	Header background color
`group.branding.textColor`	`String`	Text color
`group.branding.logo`	`Boolean`	Logo exists
`group.branding.alignment`	`String`	Logo alignment
`group.branding.background`	`Boolean`	Background exists
`group.branding.backgroundPositionX`	`Number`	Background image X position
`group.branding.backgroundPositionY`	`Number`	Background image Y position
`group.branding.hideBackgroundGradient`	`Boolean`	Background image Y position
`group.branding.hideLogoBackground`	`Boolean`	Background image Y position
`group.branding.hideGroupName`	`Boolean`	Background image Y position
`group.branding.hideLogo`	`Boolean`	Background image Y position
`group.lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`group.hash`	`String`	Group hash value

5.2. Note Folder

Lists notes in shared note folder.

Table 16. /v3/shares/{shareToken}/notes
Parameter	Description
`shareToken`	Share token

HTTP

GET /v3/shares/62b8d1f7-bcc0-4f97-b6c0-7f30961df9ad/notes?parentId=1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/62b8d1f7-bcc0-4f97-b6c0-7f30961df9ad/notes?parentId=1' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/62b8d1f7-bcc0-4f97-b6c0-7f30961df9ad/notes?parentId=1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Table 17. Request parameters
Parameter	Description
`parentId`	Shared note folder id

Example of a success response

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" : 776
    },
    "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
}

Table 18. Definition of the returned fields
Path	Type	Description
`items[]id`	`Number`	Note id
`items[]name`	`String`	Unique name (slug)
`items[]friendlyName`	`String`	Name
`items[]contextKey`	`Object`	Context key
`items[]contextKey.id`	`Number`	Context key ID
`items[]group`	`Object`	Base details about group
`items[]template`	`Boolean`	Is a template
`items[]tags`	`String`	Comma-separated list of tags
`items[]content`	`String`	Note content
`items[]sharing`	`String`	Sharing option, determines who can see a note: [NONE, DEFAULT, MEMBERS, PUBLIC]
`items[]memberPermission`	`Number`	Member file permission mask
`items[]attachmentCount`	`Number`	Amount of attachments
`items[]commentCount`	`Number`	Amount of comments
`items[]attachments`	`Array`	List of attachments
`items[]creator`	`Object`	User created the page
`items[]lastModified`	`Number`	Date when note was last modified
`items[]versions`	`Number`	Total page vesions
`items[]dateCreated`	`Number`	Date when note was created
`items[]pageType`	`String`	PAGE or FOLDER
`items[]creator.id`	`Number`	User id
`items[]creator.name`	`String`	Full name
`items[]creator.username`	`String`	Username
`items[]creator.logo`	`Boolean`	Profile picture is defined
`items[]creator.jobTitle`	`String`	Job title
`items[]creator.lastModified`	`Number`	Last modified date
`items[]creator.enabled`	`Boolean`	Is user enabled
`items[]creator.locked`	`Boolean`	Is user locked
`items[]creator.organisation`	`String`	Organisation name
`items[]creator.email`	`String`	Email address
`items[]creator.address`	`String`	Address
`items[]creator.telephone`	`String`	Phone number
`items[]creator.other`	`String`	Optional other information
`items[]creator.timeZone`	`String`	Time zone ID
`items[]creator.locale`	`String`	Locale
`items[]creator.verifiedEmail`	`Boolean`	Is email verified
`items[]creator.twoFactorAuthentication`	`Boolean`	Is 2FA enabled
`items[]creator.twoFactorMode`	`String`	2FA mode: [AUTHENTICATOR, SMS, EMAIL]
`items[]creator.twentyFourHourTimeFormat`	`Boolean`	Time format preference - 24hr or 12hr format
`items[]creator.lastActive`	`Number`	Date the user was last active
`items[]creator.dateFormat`	`Boolean`	Date format preference - YMD (Year-Month-Day), MDY (Month/Day/Year) or DMY(Day/Month/Year)
`items[]group.id`	`Number`	User / profile id
`items[]group.name`	`String`	Group name slug, used for internal identification and URIs
`items[]group.friendlyName`	`String`	Full group name, visible to a user
`items[]group.disableComments`	`Boolean`	Is commenting disabled for group
`items[]group.branding`	`Object`	Group branding settings
`items[]group.branding.headerColor`	`String`	Header background color
`items[]group.branding.textColor`	`String`	Text color
`items[]group.branding.logo`	`Boolean`	Logo exists
`items[]group.branding.alignment`	`String`	Logo alignment
`items[]group.branding.background`	`Boolean`	Background exists
`items[]group.branding.backgroundPositionX`	`Number`	Background image X position
`items[]group.branding.backgroundPositionY`	`Number`	Background image Y position
`items[]group.branding.hideBackgroundGradient`	`Boolean`	Background image Y position
`items[]group.branding.hideLogoBackground`	`Boolean`	Background image Y position
`items[]group.branding.hideGroupName`	`Boolean`	Background image Y position
`items[]group.branding.hideLogo`	`Boolean`	Background image Y position
`items[]group.lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`items[]group.hash`	`String`	Group hash value
`items`	`Array`	Page items
`currentPage`	`Number`	Current page number
`pageSize`	`Number`	Current page size
`nextPage`	`Boolean`	Next page available
`previousPage`	`Boolean`	Previous page available
`totalPages`	`Number`	Amount of available pages
`totalResults`	`Number`	Total results

5.3. Note in shared folder

Table 19. /v3/shares/{shareToken}/notes/{note}
Parameter	Description
`shareToken`	Share token
`note`	Note id

HTTP

GET /v3/shares/b388bf30-e970-4122-a0d6-2c587460e0a6/notes/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/b388bf30-e970-4122-a0d6-2c587460e0a6/notes/1' \
    'Authorization:Bearer <YOUR-TOKEN>'

include::/home/ec2-user/clinked/clinked-api-webapp/target/generated-snippets/v3/shares/notes/subnote/curl-request.adoc[

Example of a success response

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" : 575
  },
  "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
  }
}

Table 20. Definition of the returned fields
Path	Type	Description
`id`	`Number`	Note id
`name`	`String`	Unique name (slug)
`friendlyName`	`String`	Name
`contextKey`	`Object`	Context key
`contextKey.id`	`Number`	Context key ID
`group`	`Object`	Base details about group
`template`	`Boolean`	Is a template
`tags`	`String`	Comma-separated list of tags
`content`	`String`	Note content
`sharing`	`String`	Sharing option, determines who can see a note: [NONE, DEFAULT, MEMBERS, PUBLIC]
`memberPermission`	`Number`	Member file permission mask
`attachmentCount`	`Number`	Amount of attachments
`commentCount`	`Number`	Amount of comments
`attachments`	`Array`	List of attachments
`creator`	`Object`	User created the page
`lastModified`	`Number`	Date when note was last modified
`versions`	`Number`	Total page vesions
`dateCreated`	`Number`	Date when note was created
`pageType`	`String`	PAGE or FOLDER
`creator.id`	`Number`	User id
`creator.name`	`String`	Full name
`creator.username`	`String`	Username
`creator.logo`	`Boolean`	Profile picture is defined
`creator.jobTitle`	`String`	Job title
`creator.lastModified`	`Number`	Last modified date
`creator.enabled`	`Boolean`	Is user enabled
`creator.locked`	`Boolean`	Is user locked
`creator.organisation`	`String`	Organisation name
`creator.email`	`String`	Email address
`creator.address`	`String`	Address
`creator.telephone`	`String`	Phone number
`creator.other`	`String`	Optional other information
`creator.timeZone`	`String`	Time zone ID
`creator.locale`	`String`	Locale
`creator.verifiedEmail`	`Boolean`	Is email verified
`creator.twoFactorAuthentication`	`Boolean`	Is 2FA enabled
`creator.twoFactorMode`	`String`	2FA mode: [AUTHENTICATOR, SMS, EMAIL]
`creator.twentyFourHourTimeFormat`	`Boolean`	Time format preference - 24hr or 12hr format
`creator.lastActive`	`Number`	Date the user was last active
`creator.dateFormat`	`Boolean`	Date format preference - YMD (Year-Month-Day), MDY (Month/Day/Year) or DMY(Day/Month/Year)
`group.id`	`Number`	User / profile id
`group.name`	`String`	Group name slug, used for internal identification and URIs
`group.friendlyName`	`String`	Full group name, visible to a user
`group.disableComments`	`Boolean`	Is commenting disabled for group
`group.branding`	`Object`	Group branding settings
`group.branding.headerColor`	`String`	Header background color
`group.branding.textColor`	`String`	Text color
`group.branding.logo`	`Boolean`	Logo exists
`group.branding.alignment`	`String`	Logo alignment
`group.branding.background`	`Boolean`	Background exists
`group.branding.backgroundPositionX`	`Number`	Background image X position
`group.branding.backgroundPositionY`	`Number`	Background image Y position
`group.branding.hideBackgroundGradient`	`Boolean`	Background image Y position
`group.branding.hideLogoBackground`	`Boolean`	Background image Y position
`group.branding.hideGroupName`	`Boolean`	Background image Y position
`group.branding.hideLogo`	`Boolean`	Background image Y position
`group.lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`group.hash`	`String`	Group hash value

5.4. Note versions

5.5. List versions

Table 21. /v3/shares/{shareToken}/notes/versions
Parameter	Description
`shareToken`	Share Token

HTTP

GET /v3/shares/3da95be8-96d8-4a3b-8840-c31f1f810b16/notes/versions HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/3da95be8-96d8-4a3b-8840-c31f1f810b16/notes/versions' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/3da95be8-96d8-4a3b-8840-c31f1f810b16/notes/versions' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Table 22. Request parameters
Parameter	Description
`page`	Page number to load

Example of a success response

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" : 1746042842438
  }, {
    "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" : 1746042842438
  }, {
    "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" : 1746042842438
  } ],
  "currentPage" : 1,
  "totalPages" : 1,
  "pageSize" : 3,
  "totalResults" : 3,
  "nextPage" : false,
  "previousPage" : false
}

Table 23. Definition of the returned fields
Path	Type	Description
`items`	`Array`	Page items
`currentPage`	`Number`	Current page number
`pageSize`	`Number`	Current page size
`nextPage`	`Boolean`	Next page available
`previousPage`	`Boolean`	Previous page available
`totalPages`	`Number`	Amount of available pages
`totalResults`	`Number`	Total results
`items[].id`	`Number`	ID
`items[].versionNumber`	`Number`	Version number
`items[].uploaded`	`Object`	A safe user who uploaded a file
`items[].summary`	`String`	Version description / summary
`items[].lastModified`	`Number`	Last modification timestamp
`items[].uploaded.name`	`String`	User’s full name
`items[].uploaded.username`	`String`	User’s usernae if the user is defined
`items[].uploaded.user`	`Object`	Detailed user data, will be set to null if user is deleted
`items[].uploaded.user.id`	`Number`	User / profile id
`items[].uploaded.user.name`	`String`	Full name
`items[].uploaded.user.username`	`String`	Username
`items[].uploaded.user.logo`	`Boolean`	Avatar available
`items[].uploaded.user.jobTitle`	`String`	Job title
`items[].uploaded.user.lastModified`	`Number`	Last profile update date

5.6. Download version

Table 24. /v3/shares/{shareToken}/notes/versions/{versionNumber}
Parameter	Description
`versionNumber`	Version number
`shareToken`	Share token

HTTP

GET /v3/shares/9c5fe6c7-f850-4fa6-a337-2dac6f266b70/notes/versions/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/9c5fe6c7-f850-4fa6-a337-2dac6f266b70/notes/versions/1' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/9c5fe6c7-f850-4fa6-a337-2dac6f266b70/notes/versions/1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Example of a success response

HTTP/1.1 200 OK
Content-Disposition: attachment; filename="Home+Page"
Last-Modified: Wed, 30 Apr 2025 19:54:02 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

Table 25. /v3/shares/{shareToken}/tasks
Parameter	Description
`shareToken`	Share token

HTTP

GET /v3/shares/6d147959-3a9d-42f0-a0c1-e8aadeb3b3eb/tasks HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/6d147959-3a9d-42f0-a0c1-e8aadeb3b3eb/tasks' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/6d147959-3a9d-42f0-a0c1-e8aadeb3b3eb/tasks' -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
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" : 129
  },
  "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
  }
}

Table 26. Definition of the returned fields
Path	Type	Description
`id`	`Number`	Task category ID
`contextKey`	`Object`	Сontext key
`contextKey.id`	`Number`	Сontext key ID
`name`	`String`	Task slug
`friendlyName`	`String`	Task name
`author`	`Object`	User created this task
`status`	`String`	Task status code
`priority`	`String`	Task priority
`progress`	`Number`	Task progress
`tags`	`String`	Task tags (comma separated)
`dueDate`	`String`	Zoned ISO due date-time
`dateReminder`	`String`	Zoned ISO reminder date-time
`recurrence`	`String`	Task recurrence rule
`order`	`Number`	Task order
`description`	`String`	Task description
`file`	`Object`	File to which the task is attached to
`category`	`Object`	Task category
`assignees`	`Array`	Task assignees
`sharing`	`String`	Sharing option, determines who can see a note: [NONE, DEFAULT, MEMBERS, PUBLIC]
`memberPermission`	`Number`	Member file permission mask
`attachmentCount`	`Number`	Amount of attachments
`commentCount`	`Number`	Amount of comments
`following`	`Boolean`	User is following note
`shareCount`	`Number`	Amount of shares
`userAces`	`Boolean`	Note has individual user permissions
`userPermission`	`Number`	User permission
`dateCreated`	`Number`	Date task was created
`dateCompleted`	`Number`	Date task was completed
`lastModified`	`Number`	Date task was last modified
`parent`	`Object`	Parent task
`numberOfSubTasks`	`Number`	Number of subtasks
`timeTracker`	`Object`	Task time tracker
`timeTracker.trackingStartDate`	`Number`	Tracking start date
`timeTracker.timeTracked`	`Number`	Time tracked in milliseconds
`author.id`	`Number`	User id
`author.name`	`String`	Full name
`author.username`	`String`	Username
`author.logo`	`Boolean`	Profile picture is defined
`author.jobTitle`	`String`	Job title
`author.lastModified`	`Number`	Last modified date
`group.id`	`Number`	User / profile id
`group.name`	`String`	Group name slug, used for internal identification and URIs
`group.friendlyName`	`String`	Full group name, visible to a user
`group.disableComments`	`Boolean`	Is commenting disabled for group
`group.branding`	`Object`	Group branding settings
`group.branding.headerColor`	`String`	Header background color
`group.branding.textColor`	`String`	Text color
`group.branding.logo`	`Boolean`	Logo exists
`group.branding.alignment`	`String`	Logo alignment
`group.branding.background`	`Boolean`	Background exists
`group.branding.backgroundPositionX`	`Number`	Background image X position
`group.branding.backgroundPositionY`	`Number`	Background image Y position
`group.branding.hideBackgroundGradient`	`Boolean`	Background image Y position
`group.branding.hideLogoBackground`	`Boolean`	Background image Y position
`group.branding.hideGroupName`	`Boolean`	Background image Y position
`group.branding.hideLogo`	`Boolean`	Background image Y position
`group.lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`group.hash`	`String`	Group hash value

7. Comments

7.1. Comment count

Table 27. /v3/shares/{shareToken}/context/{context}/comments
Parameter	Description
`shareToken`	Share token
`context`	Context "name_id". Supported names are: file, page, event, task, discussion

Example of a success response

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

Table 28. /v3/shares/{shareToken}/context/{context}/comments
Parameter	Description
`shareToken`	Share token
`context`	Context "name_id". Supported names are: file, page, event, task, discussion

HTTP

GET /v3/shares/38e95dfd-37cc-469b-ac4e-f5d1d60675ec/context/discussion_1/comments HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/38e95dfd-37cc-469b-ac4e-f5d1d60675ec/context/discussion_1/comments' \
    'Content-Type:application/json' \
    'Accept:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/38e95dfd-37cc-469b-ac4e-f5d1d60675ec/context/discussion_1/comments' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Table 29. Request parameters
Parameter	Description
`parent`	Parent comment id
`offset`	Comment offset

Example of a success response

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
}

Table 30. Definition of the returned fields
Path	Type	Description
`offset`	`String`	Comment offset
`items`	`Array`	Comments
`items[].comment.id`	`Number`	Comment id
`items[].comment.comment`	`String`	Comment content
`items[].comment.numberOfChildren`	`Number`	Number of children
`items[].comment.edited`	`Boolean`	Has been edited
`items[].comment.commenter.user`	`Object`	User object
`items[].comment.commenter.username`	`String`	Username
`items[].comment.commenter.name`	`String`	Name
`items[].comment.commenter.user.id`	`Number`	User id
`items[].comment.commenter.user.name`	`String`	Full name
`items[].comment.commenter.user.username`	`String`	Username
`items[].comment.commenter.user.logo`	`Boolean`	Profile picture is defined
`items[].comment.commenter.user.jobTitle`	`String`	Job title
`items[].comment.commenter.user.lastModified`	`Number`	Last modified date
`items[].comment.updater`	`Object`	User that updated the comment
`items[].comment.updater.user`	`Object`	User object
`items[].comment.updater.username`	`String`	Username
`items[].comment.updater.name`	`String`	Name
`items[].comment.updater.user.id`	`Number`	User id
`items[].comment.updater.user.name`	`String`	Full name
`items[].comment.updater.user.username`	`String`	Username
`items[].comment.updater.user.logo`	`Boolean`	Profile picture is defined
`items[].comment.updater.user.jobTitle`	`String`	Job title
`items[].comment.updater.user.lastModified`	`Number`	Last modified date
`items[].comment.dateCreated`	`Number`	Date created
`items[].comment.dateUpdated`	`Number`	Date updated
`items[].reactions`	`Object`	Comment reactions
`items[].replies`	`Object`	Comment replies
`more`	`Boolean`	Is there more results

7.3. Create comment

Table 31. /v3/shares/{shareToken}/context/{context}/comments
Parameter	Description
`shareToken`	Share token
`context`	Context "name_id". Supported names are: file, page, event, task, discussion

HTTP

POST /v3/shares/9b02ad86-de7b-494f-8f5d-56bfd08481f3/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"
}

HTTPie

$ echo '{
  "message" : "Hello"
}' | http POST 'https://api.clinked.com/v3/shares/9b02ad86-de7b-494f-8f5d-56bfd08481f3/context/event_1/comments' \
    'Content-Type:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>' \
    'Accept:application/json'

Curl

$ curl 'https://api.clinked.com/v3/shares/9b02ad86-de7b-494f-8f5d-56bfd08481f3/context/event_1/comments' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json' \
    -d '{
  "message" : "Hello"
}'

Table 32. Request fields
Path	Type	Description
`message`	`String`	Comment text
`parent`	`Number`	Parent id
`mentions`	`String`	Mentions

Example of a success response

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
}

Table 33. Definition of the returned fields
Path	Type	Description
`id`	`Number`	Comment id
`comment`	`String`	Comment content
`numberOfChildren`	`Number`	Number of children
`edited`	`Boolean`	Has been edited
`commenter.user`	`Object`	User object
`commenter.username`	`String`	Username
`commenter.name`	`String`	Name
`commenter.user.id`	`Number`	User id
`commenter.user.name`	`String`	Full name
`commenter.user.username`	`String`	Username
`commenter.user.logo`	`Boolean`	Profile picture is defined
`commenter.user.jobTitle`	`String`	Job title
`commenter.user.lastModified`	`Number`	Last modified date
`updater`	`Object`	User that updated the comment
`updater.user`	`Object`	User object
`updater.username`	`String`	Username
`updater.name`	`String`	Name
`updater.user.id`	`Number`	User id
`updater.user.name`	`String`	Full name
`updater.user.username`	`String`	Username
`updater.user.logo`	`Boolean`	Profile picture is defined
`updater.user.jobTitle`	`String`	Job title
`updater.user.lastModified`	`Number`	Last modified date
`dateCreated`	`Number`	Date created
`dateUpdated`	`Number`	Date updated

7.4. Update comment

Table 34. /v3/shares/{shareToken}/context/{context}/comments/{id}
Parameter	Description
`shareToken`	Share token
`context`	Context "name_id". Supported names are: file, page, event, task, discussion
`id`	Comment id

HTTP

PATCH /v3/shares/3a2427dc-965f-44fc-b613-b97e1c57ad5b/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"
}

HTTPie

$ echo '{
  "message" : "Hello"
}' | http PATCH 'https://api.clinked.com/v3/shares/3a2427dc-965f-44fc-b613-b97e1c57ad5b/context/event_1/comments/1' \
    'Content-Type:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>' \
    'Accept:application/json'

Curl

$ curl 'https://api.clinked.com/v3/shares/3a2427dc-965f-44fc-b613-b97e1c57ad5b/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"
}'

Table 35. Request fields
Path	Type	Description
`message`	`String`	Comment text
`parent`	`Number`	Parent id
`mentions`	`String`	Mentions

Example of a success response

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
}

Table 36. Definition of the returned fields
Path	Type	Description
`id`	`Number`	Comment id
`commenter`	`Object`	Commenter object
`commenter.user`	`Object`	Commenter user object
`commenter.name`	`String`	Commenter name
`commenter.username`	`String`	Commenter username
`comment`	`String`	Comment content
`dateCreated`	`Number`	Date created
`dateUpdated`	`Number`	Date updated
`numberOfChildren`	`Number`	Number of children
`edited`	`Boolean`	Has been edited
`updater`	`Object`	Commenter object
`updater.user`	`Object`	Commenter user object
`updater.name`	`String`	Commenter name
`updater.username`	`String`	Commenter username

Comment reactions are user-generated responses to comments in the portal.

7.5. List reactions

Table 37. /v3/shares/{shareToken}/context/{context}/reactions
Parameter	Description
`context`	example: reply_1, comment_1, discussions have 'reply', everything else 'comment'
`shareToken`	Share token

HTTP

GET /v3/shares/26033259-5570-4243-8b53-d2c1fa65f5cf/context/comment_1/reactions HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/26033259-5570-4243-8b53-d2c1fa65f5cf/context/comment_1/reactions' \
    'Content-Type:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>' \
    'Accept:application/json'

Curl

$ curl 'https://api.clinked.com/v3/shares/26033259-5570-4243-8b53-d2c1fa65f5cf/context/comment_1/reactions' -i -X GET \
    -H 'Content-Type: application/json' \
    -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
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
} ]

Table 38. Definition of the returned fields
Path	Type	Description
`[]user`	`Object`	User
`[]user.user`	`Object`	Commenter user object
`[]user.user.id`	`Number`	User id
`[]user.user.name`	`String`	Full name
`[]user.user.username`	`String`	Username
`[]user.user.logo`	`Boolean`	Profile picture is defined
`[]user.user.jobTitle`	`String`	Job title
`[]user.user.lastModified`	`Number`	Last modified date
`[]user.name`	`String`	Commenter name
`[]user.username`	`String`	Commenter username
`[]reactionType`	`String`	Reaction type: [THUMBS_UP, THUMBS_DOWN, HEART, OPEN_EYE, FIRE]
`[]dateCreated`	`Number`	Date created
`[]dateUpdated`	`Number`	Date updated
`[]disabled`	`Boolean`	Is reaction disabled

7.6. Summary

Table 39. /v3/shares/{shareToken}/context/{context}/reactions
Parameter	Description
`context`	example: reply_1, comment_1, discussions have 'reply', everything else 'comment'
`shareToken`	Share token

HTTP

GET /v3/shares/657f040b-cd41-4801-8674-28e5a8e37919/context/comment_1/reactions?summary=&summary= HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/657f040b-cd41-4801-8674-28e5a8e37919/context/comment_1/reactions?summary=&summary=' \
    'Content-Type:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>' \
    'Accept:application/json'

Curl

$ curl 'https://api.clinked.com/v3/shares/657f040b-cd41-4801-8674-28e5a8e37919/context/comment_1/reactions?summary=&summary=' -i -X GET \
    -H 'Content-Type: application/json' \
    -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
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
}

Table 40. Definition of the returned fields
Path	Type	Description
`totalReactions`	`Number`	Number of total reactions
`userReaction`	`String`	Reaction - [THUMBS_UP, THUMBS_DOWN, HEART, OPEN_EYE, FIRE]
`thumbsUp`	`Number`	Number of thumbs up
`thumbsDown`	`Number`	Number of thumbs down
`heart`	`Number`	Number of hearts
`openEye`	`Number`	Number of open eye
`fire`	`Number`	Number of fire

7.7. Create reaction

Table 41. /v3/shares/{shareToken}/context/{context}/reactions
Parameter	Description
`context`	example: reply_1, comment_1, discussions have 'reply', everything else 'comment'
`shareToken`	Share token

HTTP

POST /v3/shares/e78de1ae-6c46-4ff4-9e8d-8d99ec54f019/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"
}

HTTPie

$ echo '{
  "reactionType" : "THUMBS_UP"
}' | http POST 'https://api.clinked.com/v3/shares/e78de1ae-6c46-4ff4-9e8d-8d99ec54f019/context/comment_1/reactions' \
    'Content-Type:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>' \
    'Accept:application/json'

Curl

$ curl 'https://api.clinked.com/v3/shares/e78de1ae-6c46-4ff4-9e8d-8d99ec54f019/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"
}'

Table 42. Request fields
Path	Type	Description
`reactionType`	`String`	Reaction type - [THUMBS_UP, THUMBS_DOWN, HEART, OPEN_EYE, FIRE]

Example of a success response

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
}

Table 43. Definition of the returned fields
Path	Type	Description
`user`	`Object`	User
`user.user`	`Object`	Commenter user object
`user.user.id`	`Number`	User id
`user.user.name`	`String`	Full name
`user.user.username`	`String`	Username
`user.user.logo`	`Boolean`	Profile picture is defined
`user.user.jobTitle`	`String`	Job title
`user.user.lastModified`	`Number`	Last modified date
`user.name`	`String`	Commenter name
`user.username`	`String`	Commenter username
`reactionType`	`String`	Reaction type: [THUMBS_UP, THUMBS_DOWN, HEART, OPEN_EYE, FIRE]
`dateCreated`	`Number`	Date created
`dateUpdated`	`Number`	Date updated
`disabled`	`Boolean`	Is reaction disabled

7.8. Disable reaction

Table 44. /v3/shares/{shareToken}/context/{context}/reactions
Parameter	Description
`context`	example: reply_1, comment_1, discussions have 'reply', everything else 'comment'
`shareToken`	Share token

HTTP

DELETE /v3/shares/613f7c75-e714-44b3-9e77-1642149cb55a/context/comment_1/reactions HTTP/1.1
Content-Type: application/json
Authorization: Bearer <YOUR-TOKEN>
Accept: application/json
Host: api.clinked.com

HTTPie

$ http DELETE 'https://api.clinked.com/v3/shares/613f7c75-e714-44b3-9e77-1642149cb55a/context/comment_1/reactions' \
    'Content-Type:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>' \
    'Accept:application/json'

Curl

$ curl 'https://api.clinked.com/v3/shares/613f7c75-e714-44b3-9e77-1642149cb55a/context/comment_1/reactions' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -H 'Accept: application/json'

Example of a success response

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

Table 45. /v3/shares/{shareToken}/context/{context}/attachments
Parameter	Description
`shareToken`	Share token
`context`	Context "name_id". Supported names are: file, page, event, task, discussion

HTTP

GET /v3/shares/4a1ddc42-4086-4b65-9b39-4dbbedce0fd2/context/page_1/attachments HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/4a1ddc42-4086-4b65-9b39-4dbbedce0fd2/context/page_1/attachments' \
    'Content-Type:application/json' \
    'Accept:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/4a1ddc42-4086-4b65-9b39-4dbbedce0fd2/context/page_1/attachments' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Table 46. Request parameters
Parameter	Description
`page`	Page number
`folder`	Boolean, get only folders
`name`	Attachment name
`mimeTypes`	Filter by content type

Example of a success response

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: 422

{
  "items" : [ {
    "id" : 1,
    "friendlyName" : "File Example.pdf",
    "name" : "file_example.pdf",
    "contentType" : "application/pdf",
    "size" : 1000,
    "lastModified" : 1514764800000,
    "href" : null,
    "link" : null,
    "removed" : false,
    "previewInfo" : null
  } ],
  "currentPage" : 1,
  "totalPages" : 1,
  "pageSize" : 1,
  "totalResults" : 1,
  "nextPage" : false,
  "previousPage" : false
}

Table 47. Definition of the returned fields
Path	Type	Description
`items[]id`	`Number`	Attachment id
`items[]friendlyName`	`String`	Attachment name
`items[]name`	`String`	Attachment slug
`items[]contentType`	`String`	Attachment file content type
`items[]size`	`Number`	Attachment file size
`items[]lastModified`	`Number`	Last modification date
`items[]previewInfo`	`Object`	Preview details
`items[]removed`	`Boolean`	Attached group file is removed
`items[]link`	`Number`	Linked group file ID
`items[]previewInfo.finished`	`Boolean`	Has the preview conversion finished
`items[]previewInfo.successful`	`Boolean`	Was the preview conversion successful
`items[]previewInfo.values`	`Object`	Values specific to the preview type
`items[]previewInfo.values.href`	`String`	File URL
`items[]previewInfo.values.fileId`	`Number`	File ID
`items[]previewInfo.errorCode`	`String`	Error code if preview conversion failed
`items`	`Array`	Page items
`currentPage`	`Number`	Current page number
`pageSize`	`Number`	Current page size
`nextPage`	`Boolean`	Next page available
`previousPage`	`Boolean`	Previous page available
`totalPages`	`Number`	Amount of available pages
`totalResults`	`Number`	Total results

8.2. Download attachment

Table 48. /v3/shares/{shareToken}/context/{context}/attachments/{attachment}/download
Parameter	Description
`shareToken`	Share token
`context`	Context "name_id". Supported names are: file, page, event, task, discussion
`attachment`	Attachment id

HTTP

GET /v3/shares/92d62830-07fd-4d88-82f4-e9020f0453b1/context/page_1/attachments/1/download HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/92d62830-07fd-4d88-82f4-e9020f0453b1/context/page_1/attachments/1/download' \
    'Content-Type:application/json' \
    'Accept:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/92d62830-07fd-4d88-82f4-e9020f0453b1/context/page_1/attachments/1/download' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Example of a success response

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

Table 49. /v3/shares/{shareToken}/fileList
Parameter	Description
`shareToken`	Share token

HTTP

GET /v3/shares/fad0dbde-6b6f-401d-b706-45d31406b473/fileList?page=1&size=5 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/fad0dbde-6b6f-401d-b706-45d31406b473/fileList?page=1&size=5' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/fad0dbde-6b6f-401d-b706-45d31406b473/fileList?page=1&size=5' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Table 50. Request parameters
Parameter	Description
`page`	Page number to load
`size`	Page size
`orderBy`	Order field
`ascending`	Ascending order direction
`columns`	Additional data to load
`name`	Name filter/search
`parent`	Parent folder id

Example of a success response

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" : 705
    },
    "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" : 538
    },
    "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
}

Table 51. Definition of the returned fields
Path	Type	Description
`items`	`Array`	Page items
`currentPage`	`Number`	Current page number
`pageSize`	`Number`	Current page size
`nextPage`	`Boolean`	Next page available
`previousPage`	`Boolean`	Previous page available
`totalPages`	`Number`	Amount of available pages
`totalResults`	`Number`	Total results
`items[].id`	`Number`	File id
`items[].contextKey`	`Object`	Context key
`items[].contextKey.id`	`Number`	Context key ID
`items[].group`	`Object`	Base information about the group
`items[].name`	`String`	Unique file name, generated automatically by API
`items[].friendlyName`	`String`	Full file name that should be visible to a user
`items[].contentType`	`String`	Content type
`items[].size`	`Number`	Size in bytes
`items[].uploaded`	`Object`	User who uploaded a file
`items[].versions`	`Number`	Number of versions
`items[].sharing`	`String`	Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC]
`items[].memberPermission`	`Number`	Member file permission mask
`items[].tags`	`String`	Tags separated by comma
`items[].locked`	`Boolean`	File is locked and should not be updated
`items[].locker`	`Object`	User locked the file
`items[].lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`items[].previewInfo`	`Object`	Preview data if available
`items[].path`	`Array`	Array of all file records making up the path of this file (incl. itself)
`items[].parent`	`Object`	File parent folder
`items[].summary`	`String`	Latest file version comment
`items[].following`	`Boolean`	Indicates that user is following the file record or not
`items[].commentCount`	`Number`	Amount of comments
`items[].attachmentCount`	`Number`	Amount of attachments
`items[].watermark`	`Boolean`	File watermark status
`items[].uploaded.name`	`String`	User’s full name
`items[].uploaded.user`	`Object`	Detailed user data, will be set to null if user is deleted
`items[].uploaded.username`	`String`	User username if user is defined
`items[].uploaded.user.id`	`Number`	User id
`items[].uploaded.user.name`	`String`	Full name
`items[].uploaded.user.username`	`String`	Username
`items[].uploaded.user.logo`	`Boolean`	Profile picture is defined
`items[].uploaded.user.jobTitle`	`String`	Job title
`items[].uploaded.user.lastModified`	`Number`	Last modified date
`items[].group.id`	`Number`	User / profile id
`items[].group.name`	`String`	Group name slug, used for internal identification and URIs
`items[].group.friendlyName`	`String`	Full group name, visible to a user
`items[].group.disableComments`	`Boolean`	Is commenting disabled for group
`items[].group.branding`	`Object`	Group branding settings
`items[].group.branding.headerColor`	`String`	Header background color
`items[].group.branding.textColor`	`String`	Text color
`items[].group.branding.logo`	`Boolean`	Logo exists
`items[].group.branding.alignment`	`String`	Logo alignment
`items[].group.branding.background`	`Boolean`	Background exists
`items[].group.branding.backgroundPositionX`	`Number`	Background image X position
`items[].group.branding.backgroundPositionY`	`Number`	Background image Y position
`items[].group.branding.hideBackgroundGradient`	`Boolean`	Background image Y position
`items[].group.branding.hideLogoBackground`	`Boolean`	Background image Y position
`items[].group.branding.hideGroupName`	`Boolean`	Background image Y position
`items[].group.branding.hideLogo`	`Boolean`	Background image Y position
`items[].group.lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`items[].group.hash`	`String`	Group hash value

10. Files batch download

10.1. Submit download request

Table 52. /v3/shares/{shareToken}/filesBatchDownload
Parameter	Description
`shareToken`	Share token

HTTP

POST /v3/shares/ff77eac7-94cd-47d5-897f-8f2e43bd23d6/filesBatchDownload HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com
Content-Length: 5

[ 1 ]

HTTPie

$ echo '[ 1 ]' | http POST 'https://api.clinked.com/v3/shares/ff77eac7-94cd-47d5-897f-8f2e43bd23d6/filesBatchDownload' \
    'Content-Type:application/json' \
    'Accept:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/ff77eac7-94cd-47d5-897f-8f2e43bd23d6/filesBatchDownload' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -d '[ 1 ]'

Table 53. Request fields
Path	Type	Description
`[]`	`Array`	Array of file id’s

Example of a success response

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

"d6593d8a-d90e-48c7-9542-b9ede89d9c99"

Table 54. Definition of the returned fields
Description
Download Job id

10.2. Job status

Table 55. /v3/shares/{shareToken}/filesBatchDownload/{id}/status
Parameter	Description
`shareToken`	Share token
`id`	Download job id

HTTP

GET /v3/shares/21edb867-7e29-4613-9c07-65999e7ac3fc/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

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/21edb867-7e29-4613-9c07-65999e7ac3fc/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4/status' \
    'Content-Type:application/json' \
    'Accept:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/21edb867-7e29-4613-9c07-65999e7ac3fc/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4/status' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Example of a success response for Completed job

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

Example of a success response for job in Progress

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
}

Table 56. Definition of the returned fields
Path	Type	Description
`complete`	`Number`	Completed bytes
`total`	`Number`	Total bytes

10.3. Download Files

Table 57. /v3/shares/{shareToken}/filesBatchDownload/{id}
Parameter	Description
`shareToken`	Share token
`id`	Download job id

HTTP

GET /v3/shares/9be53a56-557f-4dbb-afd1-300f4a74c28e/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4 HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/9be53a56-557f-4dbb-afd1-300f4a74c28e/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4' \
    'Content-Type:application/json' \
    'Accept:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/9be53a56-557f-4dbb-afd1-300f4a74c28e/filesBatchDownload/bf977d71-cd2c-494c-860d-3ebfb714dbf4' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Example of a success response

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. Files

11.1. Files search

Table 58. /v3/shares/{shareToken}/files
Parameter	Description
`shareToken`	Share token

HTTP

GET /v3/shares/6d8e290a-290a-435c-ab5b-a58485a3719e/files?path=file_example.pdf HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/6d8e290a-290a-435c-ab5b-a58485a3719e/files?path=file_example.pdf' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/6d8e290a-290a-435c-ab5b-a58485a3719e/files?path=file_example.pdf' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Table 59. Request parameters
Parameter	Description
`path`	File path
`exclude`	Set of file id’s

Example of a success response

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" : 381
  },
  "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
  }
}

Table 60. Definition of the returned fields
Path	Type	Description
`id`	`Number`	File id
`contextKey`	`Object`	Context key
`contextKey.id`	`Number`	Context key ID
`group`	`Object`	Base information about the group
`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
`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
`tags`	`String`	Tags separated by comma
`locked`	`Boolean`	File is locked and should not be updated
`locker`	`Object`	User locked the file
`lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`previewInfo`	`Object`	Preview data if available
`path`	`Array`	Array of all file records making up the path of this file (incl. itself)
`parent`	`Object`	File parent folder
`summary`	`String`	Latest file version comment
`following`	`Boolean`	Indicates that user is following the file record or not
`commentCount`	`Number`	Amount of comments
`attachmentCount`	`Number`	Amount of attachments
`watermark`	`Boolean`	File watermark status
`uploaded.name`	`String`	User’s full name
`uploaded.user`	`Object`	Detailed user data, will be set to null if user is deleted
`uploaded.username`	`String`	User username if user is defined
`uploaded.user.id`	`Number`	User id
`uploaded.user.name`	`String`	Full name
`uploaded.user.username`	`String`	Username
`uploaded.user.logo`	`Boolean`	Profile picture is defined
`uploaded.user.jobTitle`	`String`	Job title
`uploaded.user.lastModified`	`Number`	Last modified date
`group.id`	`Number`	User / profile id
`group.name`	`String`	Group name slug, used for internal identification and URIs
`group.friendlyName`	`String`	Full group name, visible to a user
`group.disableComments`	`Boolean`	Is commenting disabled for group
`group.branding`	`Object`	Group branding settings
`group.branding.headerColor`	`String`	Header background color
`group.branding.textColor`	`String`	Text color
`group.branding.logo`	`Boolean`	Logo exists
`group.branding.alignment`	`String`	Logo alignment
`group.branding.background`	`Boolean`	Background exists
`group.branding.backgroundPositionX`	`Number`	Background image X position
`group.branding.backgroundPositionY`	`Number`	Background image Y position
`group.branding.hideBackgroundGradient`	`Boolean`	Background image Y position
`group.branding.hideLogoBackground`	`Boolean`	Background image Y position
`group.branding.hideGroupName`	`Boolean`	Background image Y position
`group.branding.hideLogo`	`Boolean`	Background image Y position
`group.lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`group.hash`	`String`	Group hash value

11.2. File details

Returns detailed information about a single file.

Table 61. /v3/shares/{shareToken}/files/{file}
Parameter	Description
`shareToken`	Share token
`file`	File id

HTTP

GET /v3/shares/908fd8be-de20-4587-a178-f29dade3b0aa/files/1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/908fd8be-de20-4587-a178-f29dade3b0aa/files/1' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/908fd8be-de20-4587-a178-f29dade3b0aa/files/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
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" : 239
  },
  "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
  }
}

Table 62. Definition of the returned fields
Path	Type	Description
`id`	`Number`	File id
`contextKey`	`Object`	Context key
`contextKey.id`	`Number`	Context key ID
`group`	`Object`	Base information about the group
`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
`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
`tags`	`String`	Tags separated by comma
`locked`	`Boolean`	File is locked and should not be updated
`locker`	`Object`	User locked the file
`lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`previewInfo`	`Object`	Preview data if available
`path`	`Array`	Array of all file records making up the path of this file (incl. itself)
`parent`	`Object`	File parent folder
`summary`	`String`	Latest file version comment
`following`	`Boolean`	Indicates that user is following the file record or not
`commentCount`	`Number`	Amount of comments
`attachmentCount`	`Number`	Amount of attachments
`watermark`	`Boolean`	File watermark status
`uploaded.name`	`String`	User’s full name
`uploaded.user`	`Object`	Detailed user data, will be set to null if user is deleted
`uploaded.username`	`String`	User username if user is defined
`uploaded.user.id`	`Number`	User id
`uploaded.user.name`	`String`	Full name
`uploaded.user.username`	`String`	Username
`uploaded.user.logo`	`Boolean`	Profile picture is defined
`uploaded.user.jobTitle`	`String`	Job title
`uploaded.user.lastModified`	`Number`	Last modified date
`group.id`	`Number`	User / profile id
`group.name`	`String`	Group name slug, used for internal identification and URIs
`group.friendlyName`	`String`	Full group name, visible to a user
`group.disableComments`	`Boolean`	Is commenting disabled for group
`group.branding`	`Object`	Group branding settings
`group.branding.headerColor`	`String`	Header background color
`group.branding.textColor`	`String`	Text color
`group.branding.logo`	`Boolean`	Logo exists
`group.branding.alignment`	`String`	Logo alignment
`group.branding.background`	`Boolean`	Background exists
`group.branding.backgroundPositionX`	`Number`	Background image X position
`group.branding.backgroundPositionY`	`Number`	Background image Y position
`group.branding.hideBackgroundGradient`	`Boolean`	Background image Y position
`group.branding.hideLogoBackground`	`Boolean`	Background image Y position
`group.branding.hideGroupName`	`Boolean`	Background image Y position
`group.branding.hideLogo`	`Boolean`	Background image Y position
`group.lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`group.hash`	`String`	Group hash value

11.3. File Preview

Table 63. /v3/shares/{shareToken}/files/{file}/preview
Parameter	Description
`shareToken`	Share token
`file`	File id

HTTP

GET /v3/shares/086d0285-f416-4ae5-89e7-6cafb0aa4629/files/1/preview?path=file_example.pdf HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/086d0285-f416-4ae5-89e7-6cafb0aa4629/files/1/preview?path=file_example.pdf' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/086d0285-f416-4ae5-89e7-6cafb0aa4629/files/1/preview?path=file_example.pdf' -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
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"
}

Table 64. Definition of the returned fields
Path	Type	Description
`session`	`Object`	Session
`session.id`	`String`	Session id
`session.dateCreated`	`String`	Date created
`session.dateExpire`	`String`	Date expire
`session.data.print`	`Boolean`	Has write permission
`session.data.annotate`	`Boolean`	Are comments not disabled
`session.data.user`	`Object`	User
`session.data.user.id`	`Number`	User id
`session.data.user.name`	`String`	User name
`url`	`String`	Preview url
`websocketUrl`	`String`	Websocket url
`embedUrl`	`String`	Embed url

11.4. Thumbnail

Download file thumbnail if it has one, otherwise default thumbnail gets returned.

Table 65. /v3/shares/{shareToken}/files/{file}/thumbnail
Parameter	Description
`shareToken`	Share token
`file`	File id

HTTP

GET /v3/shares/6ba937d4-f3d5-4c71-baa7-d1e77a4cf876/files/1/thumbnail?path=file_example.pdf HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/6ba937d4-f3d5-4c71-baa7-d1e77a4cf876/files/1/thumbnail?path=file_example.pdf' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/6ba937d4-f3d5-4c71-baa7-d1e77a4cf876/files/1/thumbnail?path=file_example.pdf' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Example of a success response

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

Table 66. /v3/shares/{shareToken}/files/{file}/download
Parameter	Description
`shareToken`	Share token
`file`	File id

HTTP

GET /v3/shares/b22ef647-b8cf-43c6-95df-5189054b7122/files/1/download?path=file_example.pdf HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/b22ef647-b8cf-43c6-95df-5189054b7122/files/1/download?path=file_example.pdf' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/b22ef647-b8cf-43c6-95df-5189054b7122/files/1/download?path=file_example.pdf' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Example of a success response

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.

Table 67. /v3/shares/{shareToken}/files/{file}
Parameter	Description
`shareToken`	Share token
`file`	File id

HTTP

POST /v3/shares/074491d9-93fa-484f-8d21-b166fcf49926/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"
}

HTTPie

$ echo '{
  "friendlyName" : "FileName",
  "memberPermission" : 8,
  "sharing" : "MEMBERS",
  "versionSummary" : "Inital version"
}' | http POST 'https://api.clinked.com/v3/shares/074491d9-93fa-484f-8d21-b166fcf49926/files/1?path=file_example.pdf' \
    'Content-Type:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/074491d9-93fa-484f-8d21-b166fcf49926/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"
}'

Table 68. Request fields
Path	Type	Description
`friendlyName`	`String`	Full file name
`sharing`	`String`	Sharing option, determines who can see a file: [NONE, DEFAULT, MEMBERS, PUBLIC]
`memberPermission`	`Number`	Member file permission mask
`versionSummary`	`String`	Version summary text
`tempFile`	`Number`	Temp file id

Example of a success response

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" : 1746042837541,
  "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
  }
}

Table 69. Definition of the returned fields
Path	Type	Description
`id`	`Number`	File id
`contextKey`	`Object`	Context key
`contextKey.id`	`Number`	Context key ID
`group`	`Object`	Base information about the group
`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
`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
`tags`	`String`	Tags separated by comma
`locked`	`Boolean`	File is locked and should not be updated
`locker`	`Object`	User locked the file
`lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`previewInfo`	`Object`	Preview data if available
`path`	`Array`	Array of all file records making up the path of this file (incl. itself)
`parent`	`Object`	File parent folder
`summary`	`String`	Latest file version comment
`following`	`Boolean`	Indicates that user is following the file record or not
`commentCount`	`Number`	Amount of comments
`attachmentCount`	`Number`	Amount of attachments
`watermark`	`Boolean`	File watermark status
`uploaded.name`	`String`	User’s full name
`uploaded.user`	`Object`	Detailed user data, will be set to null if user is deleted
`uploaded.username`	`String`	User username if user is defined
`uploaded.user.id`	`Number`	User id
`uploaded.user.name`	`String`	Full name
`uploaded.user.username`	`String`	Username
`uploaded.user.logo`	`Boolean`	Profile picture is defined
`uploaded.user.jobTitle`	`String`	Job title
`uploaded.user.lastModified`	`Number`	Last modified date
`group.id`	`Number`	User / profile id
`group.name`	`String`	Group name slug, used for internal identification and URIs
`group.friendlyName`	`String`	Full group name, visible to a user
`group.disableComments`	`Boolean`	Is commenting disabled for group
`group.branding`	`Object`	Group branding settings
`group.branding.headerColor`	`String`	Header background color
`group.branding.textColor`	`String`	Text color
`group.branding.logo`	`Boolean`	Logo exists
`group.branding.alignment`	`String`	Logo alignment
`group.branding.background`	`Boolean`	Background exists
`group.branding.backgroundPositionX`	`Number`	Background image X position
`group.branding.backgroundPositionY`	`Number`	Background image Y position
`group.branding.hideBackgroundGradient`	`Boolean`	Background image Y position
`group.branding.hideLogoBackground`	`Boolean`	Background image Y position
`group.branding.hideGroupName`	`Boolean`	Background image Y position
`group.branding.hideLogo`	`Boolean`	Background image Y position
`group.lastModified`	`Number`	Last modification date (timestamp in milliseconds)
`group.hash`	`String`	Group hash value

11.7. File versions

11.8. List versions

Table 70. /v3/shares/{shareToken}/files/{file}/versions
Parameter	Description
`shareToken`	Share token
`file`	File id

HTTP

GET /v3/shares/101468dc-04dd-40f9-95a1-cce8c8e08220/files/1/versions?page=1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/101468dc-04dd-40f9-95a1-cce8c8e08220/files/1/versions?page=1' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/101468dc-04dd-40f9-95a1-cce8c8e08220/files/1/versions?page=1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Table 71. Request parameters
Parameter	Description
`page`	Page number

Table 72. Example of a success response
Path	Type	Description
`items[]id`	`Number`	ID
`items[]versionNumber`	`Number`	Version number
`items[]uploaded`	`Object`	A safe user who uploaded a file
`items[]summary`	`String`	Version description / summary
`items[]lastModified`	`Number`	Last modification timestamp
`items[]size`	`Number`	Size in bytes
`items[]uploaded.name`	`String`	User’s full name
`items[]uploaded.username`	`String`	User’s usernae if the user is defined
`items[]uploaded.user`	`Object`	Detailed user data, will be set to null if user is deleted
`items[]uploaded.user.id`	`Number`	User / profile id
`items[]uploaded.user.name`	`String`	Full name
`items[]uploaded.user.username`	`String`	Username
`items[]uploaded.user.logo`	`Boolean`	Avatar available
`items[]uploaded.user.jobTitle`	`String`	Job title
`items[]uploaded.user.lastModified`	`Number`	Last profile update date
`items`	`Array`	Page items
`currentPage`	`Number`	Current page number
`pageSize`	`Number`	Current page size
`nextPage`	`Boolean`	Next page available
`previousPage`	`Boolean`	Previous page available
`totalPages`	`Number`	Amount of available pages
`totalResults`	`Number`	Total results

11.9. Download version

Table 73. /v3/shares/{shareToken}/files/{file}/versions/{version}
Parameter	Description
`shareToken`	Share token
`file`	File id
`version`	Version id

HTTP

GET /v3/shares/fe4c2239-1e72-4016-9dfe-037394285e91/files/1/versions/2?page=1 HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/fe4c2239-1e72-4016-9dfe-037394285e91/files/1/versions/2?page=1' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/fe4c2239-1e72-4016-9dfe-037394285e91/files/1/versions/2?page=1' -i -X GET \
    -H 'Authorization: Bearer <YOUR-TOKEN>'

Example of a success response

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.10. File approval requests

11.11. List approval requests

Table 74. /v3/shares/{shareToken}/files/{file}/approvals
Parameter	Description
`shareToken`	Share token
`file`	File id

HTTP

GET /v3/shares/aadcf414-6c3b-4825-bd5a-d7e93fc5801e/files/1/approvals HTTP/1.1
Authorization: Bearer <YOUR-TOKEN>
Host: api.clinked.com

HTTPie

$ http GET 'https://api.clinked.com/v3/shares/aadcf414-6c3b-4825-bd5a-d7e93fc5801e/files/1/approvals' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/aadcf414-6c3b-4825-bd5a-d7e93fc5801e/files/1/approvals' -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
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: 1603

{
  "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" : 1746042836770,
      "size" : 1024
    },
    "requests" : [ {
      "id" : 1,
      "contextKey" : {
        "id" : 66
      },
      "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" : 558
        },
        "type" : "group"
      },
      "sourceName" : "jack.bauer@clinked.com",
      "targetName" : "jack.bauer@clinked.com",
      "type" : "ACCEPT_DECLINE",
      "status" : "NONE",
      "scope" : "1",
      "parameters" : null,
      "lastModified" : 1746042836770,
      "account" : {
        "id" : 1,
        "name" : "awesome_org",
        "friendlyName" : "Awesome Organisation",
        "enabled" : true
      }
    } ]
  } ],
  "currentPage" : 1,
  "pageSize" : 5,
  "nextPage" : false,
  "previousPage" : false
}

Table 75. Definition of the returned fields
Path	Type	Description
`items`	`Array`	Page items
`currentPage`	`Number`	Current page number
`pageSize`	`Number`	Current page size
`nextPage`	`Boolean`	Next page available
`previousPage`	`Boolean`	Previous page available
`totalPages`	`Number`	Amount of available pages
`totalResults`	`Number`	Total results
`items[].version`	`Object`	File version
`items[].requests`	`Array`	List of requests
`items[].version.id`	`Number`	ID
`items[].version.versionNumber`	`Number`	Version number
`items[].version.uploaded`	`Object`	A safe user who uploaded a file
`items[].version.summary`	`String`	Version description / summary
`items[].version.lastModified`	`Number`	Last modification timestamp
`items[].version.size`	`Number`	Size in bytes
`items[].version.uploaded.name`	`String`	User’s full name
`items[].version.uploaded.username`	`String`	User’s usernae if the user is defined
`items[].version.uploaded.user`	`Object`	Detailed user data, will be set to null if user is deleted
`items[].version.uploaded.user.id`	`Number`	User / profile id
`items[].version.uploaded.user.name`	`String`	Full name
`items[].version.uploaded.user.username`	`String`	Username
`items[].version.uploaded.user.logo`	`Boolean`	Avatar available
`items[].version.uploaded.user.jobTitle`	`String`	Job title
`items[].version.uploaded.user.lastModified`	`Number`	Last profile update date
`items[].requests[].id`	`Number`	Entity id
`items[].requests[].contextKey`	`Object`	Context key
`items[].requests[].contextKey.id`	`Number`	Context key ID
`items[].requests[].source`	`Object`	User who created a request
`items[].requests[].target`	`Object`	Target user
`items[].requests[].container`	`Object`	Request container
`items[].requests[].sourceName`	`String`	Source user name
`items[].requests[].targetName`	`String`	Target user name
`items[].requests[].type`	`String`	Request type
`items[].requests[].status`	`String`	Request status
`items[].requests[].scope`	`String`	Scope
`items[].requests[].parameters`	`Varies`	Additional parameters
`items[].requests[].lastModified`	`Number`	Last modification date
`items[].requests[].source.id`	`Number`	User id
`items[].requests[].source.name`	`String`	Full name
`items[].requests[].source.username`	`String`	Username
`items[].requests[].source.logo`	`Boolean`	Profile picture is defined
`items[].requests[].source.jobTitle`	`String`	Job title
`items[].requests[].source.lastModified`	`Number`	Last modified date
`items[].requests[].target.id`	`Number`	User id
`items[].requests[].target.name`	`String`	Full name
`items[].requests[].target.username`	`String`	Username
`items[].requests[].target.logo`	`Boolean`	Profile picture is defined
`items[].requests[].target.jobTitle`	`String`	Job title
`items[].requests[].target.lastModified`	`Number`	Last modified date
`items[].requests[].account.id`	`Number`	User / profile id
`items[].requests[].account.name`	`String`	Account name slug, used for internal identification and URIs
`items[].requests[].account.friendlyName`	`String`	Full account name, visible to a user
`items[].requests[].account.enabled`	`Boolean`	Is account enabled

11.12. Update approval request

Table 76. /v3/shares/{shareToken}/files/{file}/approvals/{request}
Parameter	Description
`shareToken`	Share token
`file`	File id
`request`	Request id

HTTP

PATCH /v3/shares/a34e4137-aa92-4eab-ad88-aeddcb95b1db/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"
}

HTTPie

$ echo '{
  "status" : "ACCEPT",
  "parameters" : "Approved"
}' | http PATCH 'https://api.clinked.com/v3/shares/a34e4137-aa92-4eab-ad88-aeddcb95b1db/files/1/approvals/2' \
    'Content-Type:application/json' \
    'Authorization:Bearer <YOUR-TOKEN>'

Curl

$ curl 'https://api.clinked.com/v3/shares/a34e4137-aa92-4eab-ad88-aeddcb95b1db/files/1/approvals/2' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer <YOUR-TOKEN>' \
    -d '{
  "status" : "ACCEPT",
  "parameters" : "Approved"
}'

Table 77. Request fields
Path	Type	Description
`status`	`String`	Approval status - [NONE, ACCEPT, DECLINE, MAYBE, REJECT]
`parameters`	`String`	Approval message

Example of a success response

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" : 973
  },
  "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" : 448
    },
    "type" : "group"
  },
  "sourceName" : "guest@test.me",
  "targetName" : "guest@test.me",
  "type" : "FILE_APPROVAL",
  "status" : "ACCEPT",
  "scope" : "1",
  "parameters" : null,
  "lastModified" : 1746042836699,
  "account" : {
    "id" : 1,
    "name" : "awesome_org",
    "friendlyName" : "Awesome Organisation",
    "enabled" : true
  }
}

Table 78. Definition of the returned fields
Path	Type	Description
`id`	`Number`	Entity id
`contextKey`	`Object`	Context key
`contextKey.id`	`Number`	Context key ID
`source`	`Object`	User who created a request
`target`	`Object`	Target user
`container`	`Object`	Request container
`sourceName`	`String`	Source user name
`targetName`	`String`	Target user name
`type`	`String`	Request type
`status`	`String`	Request status
`scope`	`String`	Scope
`parameters`	`Varies`	Additional parameters
`lastModified`	`Number`	Last modification date
`source.id`	`Number`	User id
`source.name`	`String`	Full name
`source.username`	`String`	Username
`source.logo`	`Boolean`	Profile picture is defined
`source.jobTitle`	`String`	Job title
`source.lastModified`	`Number`	Last modified date
`target.id`	`Number`	User id
`target.name`	`String`	Full name
`target.username`	`String`	Username
`target.logo`	`Boolean`	Profile picture is defined
`target.jobTitle`	`String`	Job title
`target.lastModified`	`Number`	Last modified date
`account.id`	`Number`	User / profile id
`account.name`	`String`	Account name slug, used for internal identification and URIs
`account.friendlyName`	`String`	Full account name, visible to a user
`account.enabled`	`Boolean`	Is account enabled