Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /penpot-collaboration | Type: Application | PCID required: Yes
POST create-comment
Parameters:
Parameter Type Required Default Description contentstring Yes — The content value mentionsstring[] No — Set of Strings shareIdstring No — UUID formatted string threadIdstring Yes — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"content" : {
"type" : "string" ,
"description" : "The content value"
},
"mentions" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid"
},
"description" : "Set of Strings"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"threadId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"content" ,
"threadId"
]
}
POST create-comment-thread
Parameters:
Parameter Type Required Default Description contentstring Yes — The content value fileIdstring Yes — UUID formatted string frameIdstring Yes — UUID formatted string mentionsstring[] No — Set of Strings pageIdstring Yes — UUID formatted string positionobject Yes — A 2D point with x and y coordinates shareIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"content" : {
"type" : "string" ,
"description" : "The content value"
},
"fileId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"frameId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"mentions" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid"
},
"description" : "Set of Strings"
},
"pageId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"position" : {
"type" : "object" ,
"description" : "A 2D point with x and y coordinates" ,
"properties" : {
"x" : {
"type" : "number" ,
"description" : "X coordinate"
},
"y" : {
"type" : "number" ,
"description" : "Y coordinate"
}
},
"required" : [
"x" ,
"y"
]
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"content" ,
"fileId" ,
"frameId" ,
"pageId" ,
"position"
]
}
penpot_collaboration_create_share_link
Creates a share-link object. Share links are resources that allows external users access to specific pages of a file with specific permissions (who-comment and who-inspect).
Parameters:
Parameter Type Required Default Description fileIdstring Yes — UUID formatted string pagesstring[] Yes — The pages value whoCommentstring Yes — Who Comment whoInspectstring Yes — Who Inspect
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"fileId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"pages" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid"
},
"description" : "The pages value"
},
"whoComment" : {
"type" : "string" ,
"description" : "Who Comment"
},
"whoInspect" : {
"type" : "string" ,
"description" : "Who Inspect"
}
},
"required" : [
"PCID" ,
"fileId" ,
"pages" ,
"whoComment" ,
"whoInspect"
]
}
penpot_collaboration_create_webhook
POST create-webhook
Parameters:
Parameter Type Required Default Description mtypestring Yes — The mtype value teamIdstring Yes — UUID formatted string uristring Yes — URI formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"mtype" : {
"type" : "string" ,
"description" : "The mtype value" ,
"enum" : [
"application/json" ,
"application/transit+json"
]
},
"teamId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"uri" : {
"type" : "string" ,
"description" : "URI formatted string"
}
},
"required" : [
"PCID" ,
"mtype" ,
"teamId" ,
"uri"
]
}
POST delete-comment
Parameters:
Parameter Type Required Default Description idstring Yes — UUID formatted string shareIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"id"
]
}
POST delete-comment-thread
Parameters:
Parameter Type Required Default Description idstring Yes — UUID formatted string shareIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"id"
]
}
penpot_collaboration_delete_share_link
POST delete-share-link
Parameters:
Parameter Type Required Default Description idstring Yes — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"id"
]
}
penpot_collaboration_delete_webhook
POST delete-webhook
Parameters:
Parameter Type Required Default Description idstring Yes — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"id"
]
}
POST get-comment-thread
Parameters:
Parameter Type Required Default Description fileIdstring Yes — UUID formatted string idstring Yes — UUID formatted string shareIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"fileId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"fileId" ,
"id"
]
}
POST get-comment-threads
Parameters:
Parameter Type Required Default Description fileIdstring No — UUID formatted string shareIdstring No — UUID formatted string teamIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"fileId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"teamId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID"
]
}
POST get-comments
Parameters:
Parameter Type Required Default Description shareIdstring No — UUID formatted string threadIdstring Yes — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"threadId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"threadId"
]
}
Retrieves a list of profiles with limited set of properties of all participants on comment threads of the file.
Parameters:
Parameter Type Required Default Description fileIdstring Yes — UUID formatted string shareIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"fileId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"fileId"
]
}
POST get-unread-comment-threads
Parameters:
Parameter Type Required Default Description teamIdstring Yes — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"teamId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"teamId"
]
}
penpot_collaboration_get_webhooks
POST get-webhooks
Parameters:
Parameter Type Required Default Description teamIdstring Yes — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"teamId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"teamId"
]
}
penpot_collaboration_mark_all_threads_as_read
POST mark-all-threads-as-read
Parameters:
Parameter Type Required Default Description threadsstring[] Yes — The threads value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"threads" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid"
},
"description" : "The threads value"
}
},
"required" : [
"PCID" ,
"threads"
]
}
POST update-comment
Parameters:
Parameter Type Required Default Description contentstring Yes — The content value idstring Yes — UUID formatted string mentionsstring[] No — Set of Strings shareIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"content" : {
"type" : "string" ,
"description" : "The content value"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"mentions" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid"
},
"description" : "Set of Strings"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"content" ,
"id"
]
}
POST update-comment-thread
Parameters:
Parameter Type Required Default Description idstring Yes — UUID formatted string isResolvedboolean Yes — Is Resolved shareIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"isResolved" : {
"type" : "boolean" ,
"description" : "Is Resolved"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"id" ,
"isResolved"
]
}
POST update-comment-thread-frame
Parameters:
Parameter Type Required Default Description frameIdstring Yes — UUID formatted string idstring Yes — UUID formatted string shareIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"frameId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"frameId" ,
"id"
]
}
POST update-comment-thread-position
Parameters:
Parameter Type Required Default Description frameIdstring Yes — UUID formatted string idstring Yes — UUID formatted string positionobject Yes — A 2D point with x and y coordinates shareIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"frameId" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"position" : {
"type" : "object" ,
"description" : "A 2D point with x and y coordinates" ,
"properties" : {
"x" : {
"type" : "number" ,
"description" : "X coordinate"
},
"y" : {
"type" : "number" ,
"description" : "Y coordinate"
}
},
"required" : [
"x" ,
"y"
]
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"frameId" ,
"id" ,
"position"
]
}
POST update-comment-thread-status
Parameters:
Parameter Type Required Default Description idstring Yes — UUID formatted string shareIdstring No — UUID formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"shareId" : {
"type" : "string" ,
"description" : "UUID formatted string"
}
},
"required" : [
"PCID" ,
"id"
]
}
penpot_collaboration_update_webhook
POST update-webhook
Parameters:
Parameter Type Required Default Description idstring Yes — UUID formatted string isActiveboolean Yes — boolean mtypestring Yes — The mtype value uristring Yes — URI formatted string
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "UUID formatted string"
},
"isActive" : {
"type" : "boolean" ,
"description" : "boolean"
},
"mtype" : {
"type" : "string" ,
"description" : "The mtype value" ,
"enum" : [
"application/json" ,
"application/transit+json"
]
},
"uri" : {
"type" : "string" ,
"description" : "URI formatted string"
}
},
"required" : [
"PCID" ,
"id" ,
"isActive" ,
"mtype" ,
"uri"
]
}