Skip to main content
Server path: /penpot-design | Type: Application | PCID required: Yes

Tools


penpot_design_clone_template

Clone into the specified project the template by its id. Parameters:

penpot_design_create_file

POST create-file Parameters:

penpot_design_create_file_snapshot

POST create-file-snapshot Parameters:

penpot_design_create_project

POST create-project Parameters:

penpot_design_delete_file

POST delete-file Parameters:

penpot_design_delete_file_snapshot

POST delete-file-snapshot Parameters:

penpot_design_delete_project

POST delete-project Parameters:

penpot_design_duplicate_file

Duplicate a single file in the same team. Parameters:

penpot_design_duplicate_project

Duplicate an entire project with all the files Parameters:

penpot_design_get_all_projects

POST get-all-projects

penpot_design_get_file

Retrieve a file by its ID. Only authenticated users. Parameters:

penpot_design_get_file_info

Retrieve minimal file info by its ID. Parameters:

penpot_design_get_file_libraries

Get libraries used by the specified file. Parameters:

penpot_design_get_file_snapshots

POST get-file-snapshots Parameters:

penpot_design_get_file_summary

Retrieve a file summary by its ID. Only authenticated users. Parameters:

penpot_design_get_library_file_references

Returns all the file references that use specified file (library) id. Parameters:

penpot_design_get_library_usage

Gets the number of files that use the specified library. Parameters:

penpot_design_get_page

Retrieves the page data from file and returns it. If no page-id is specified, the first page will be returned. If object-id is specified, only that object and its children will be returned in the page objects data structure. If you specify the object-id, the page-id parameter becomes mandatory. Mainly used for rendering purposes on the exporter. It does not accepts client features. Parameters:

penpot_design_get_project

POST get-project Parameters:

penpot_design_get_project_files

Get all files for the specified project. Parameters:

penpot_design_get_projects

POST get-projects Parameters:

penpot_design_get_team_deleted_files

POST get-team-deleted-files Parameters:

penpot_design_get_team_recent_files

POST get-team-recent-files Parameters:

penpot_design_get_team_shared_files

Get all file (libraries) for the specified team. Parameters:

penpot_design_has_file_libraries

Checks if the file has libraries. Returns a boolean Parameters:

penpot_design_ignore_file_library_sync_status

Ignore updates in linked files Parameters:
Link a file to a library. Returns the recursive list of libraries used by that library Parameters:

penpot_design_lock_file_snapshot

POST lock-file-snapshot Parameters:

penpot_design_move_files

Move a set of files from one project to other. Parameters:

penpot_design_move_project

Move projects between teams Parameters:

penpot_design_permanently_delete_team_files

Mark the specified files to be deleted immediatelly on the specified team. The team-id on params will be used to filter and check writable permissons on team. Parameters:

penpot_design_rename_file

POST rename-file Parameters:

penpot_design_rename_project

POST rename-project Parameters:

penpot_design_restore_deleted_team_files

Removes the deletion mark from the specified files (and respective projects) on the specified team. Parameters:

penpot_design_restore_file_snapshot

POST restore-file-snapshot Parameters:

penpot_design_search_files

POST search-files Parameters:

penpot_design_set_file_shared

POST set-file-shared Parameters:
POST unlink-file-from-library Parameters:

penpot_design_unlock_file_snapshot

POST unlock-file-snapshot Parameters:

penpot_design_update_file

POST update-file Parameters:

penpot_design_update_file_library_sync_status

Update the synchronization status of a file->library link Parameters:

penpot_design_update_file_snapshot

POST update-file-snapshot Parameters:

penpot_design_update_project_pin

POST update-project-pin Parameters: