Skip to main content
New to Corsair? See API access, authentication, and error handling.

Access Tokens

delete

accessTokens.delete Revoke an API access token; apps using it stop working Risk: destructive · Irreversible
Input Revoking a token immediately breaks apps using it. Output

list

accessTokens.list List the API access tokens of the account (names only, never values) Risk: read
Input: empty object Output: object[]

Comments

create

comments.create Comment on a thread Risk: write
Input Content is capped at 750 characters. Output

list

comments.list List the comments of a thread Risk: read
Input Output: object[]

threadCreate

comments.threadCreate Open a comment thread on a file page Risk: write
Input
Output

threadGet

comments.threadGet Read one comment thread Risk: read
Input Output

threadsList

comments.threadsList List the comment threads of a file Risk: read
Input Takes a fileId; the RPC answers 404 when called with only a team. Output: object[]

Files

create

files.create Create a design file in a project Risk: write
Input Output

delete

files.delete Delete a design file Risk: destructive · Irreversible
Input Output

duplicate

files.duplicate Duplicate a design file Risk: write
Input Output

get

files.get Read one design file with its data Risk: read
Input The answer includes the full file data tree. Output

rename

files.rename Rename a design file Risk: write
Input Output

shareLinkCreate

files.shareLinkCreate Create a share link for a file Risk: write
Input Output

shareLinkDelete

files.shareLinkDelete Delete a share link; the link stops working immediately Risk: write
Input Output

snapshotsCreate

files.snapshotsCreate Create a snapshot of a file Risk: write
Input Output

snapshotsDelete

files.snapshotsDelete Delete a file snapshot Risk: destructive · Irreversible
Input Output

snapshotsList

files.snapshotsList List the snapshots of a file Risk: read
Input Output: object[]

Projects

create

projects.create Create a project in a team Risk: write
Input Output

delete

projects.delete Delete a project with its files Risk: destructive · Irreversible
Input Output

duplicate

projects.duplicate Duplicate a project Risk: write
Input Output

get

projects.get Read one project by id Risk: read
Input Output

listAll

projects.listAll List all projects of the authenticated profile Risk: read
Input: empty object Returns every project the profile can see across teams. Output: object[]

rename

projects.rename Rename a project Risk: write
Input The RPC answers an empty body; the plugin answers the id and the new name. Output

Teams

create

teams.create Create a team Risk: write
Input Output

delete

teams.delete Delete a team with its projects and files Risk: destructive · Irreversible
Input Output

get

teams.get Read one team Risk: read
Input Takes the team id. Output

list

teams.list List the teams of the authenticated profile Risk: read
Input: empty object Returns the teams of the authenticated profile. Output: object[]

Webhooks

create

webhooks.create Create a webhook for a team Risk: write
Input mtype is application/json: the plugin reads JSON deliveries only (Penpot can also send Transit or form bodies, which it does not decode). Penpot calls the URI on create and refuses one that does not answer (500 webhook-validation). Output

delete

webhooks.delete Delete a webhook; deliveries stop until it is created again Risk: destructive · Irreversible
Input Deliveries stop until the webhook is created again. Output

list

webhooks.list List the webhooks of a team Risk: read
Input Output: object[]

update

webhooks.update Update a webhook URL, payload format or active state Risk: write
Input Output