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

Tools

ToolDescription
zeplin_design_create_screenCreate a new screen
zeplin_design_create_screen_annotationCreate an annotation
zeplin_design_create_screen_commentCreate a comment
zeplin_design_create_screen_noteCreate a note
zeplin_design_create_screen_versionCreate a new screen version
zeplin_design_delete_screen_annotationDelete an annotation
zeplin_design_delete_screen_commentDelete comment
zeplin_design_delete_screen_noteDelete a note
zeplin_design_get_latest_screen_versionGet the latest screen version
zeplin_design_get_project_componentGet a single project component
zeplin_design_get_project_component_latest_versionGet latest project component version
zeplin_design_get_project_component_sectionsGet project component sections
zeplin_design_get_project_componentsGet project components
zeplin_design_get_project_connected_componentsGet project connected components
zeplin_design_get_project_flow_boardGet a single project flow board
zeplin_design_get_project_flow_board_connectorGet a single project flow board connector
zeplin_design_get_project_flow_board_connectorsGet project flow board connectors
zeplin_design_get_project_flow_board_groupsGet project flow board groups
zeplin_design_get_project_flow_board_nodeGet a single project flow board node
zeplin_design_get_project_flow_board_nodesGet project flow board nodes
zeplin_design_get_project_flow_boardsGet project flow boards
zeplin_design_get_project_pagesGet project pages
zeplin_design_get_project_screensGet project screens
zeplin_design_get_screenGet a single screen
zeplin_design_get_screen_annotationGet a single screen annotation
zeplin_design_get_screen_annotationsGet screen annotations
zeplin_design_get_screen_annotations_note_typesGet screen annotation note types
zeplin_design_get_screen_componentsGet screen components
zeplin_design_get_screen_noteGet a single screen note
zeplin_design_get_screen_notesGet screen notes
zeplin_design_get_screen_sectionGet a single screen section
zeplin_design_get_screen_sectionsGet screen sections
zeplin_design_get_screen_variantGet a single screen variant
zeplin_design_get_screen_variantsGet screen variants
zeplin_design_get_screen_versionGet a single screen version
zeplin_design_get_screen_versionsGet screen versions
zeplin_design_get_styleguide_componentGet a single styleguide component
zeplin_design_get_styleguide_component_latest_versionGet latest styleguide component version
zeplin_design_get_styleguide_component_sectionsGet styleguide component sections
zeplin_design_get_styleguide_componentsGet styleguide components
zeplin_design_get_styleguide_connected_componentsGet styleguide connected components
zeplin_design_get_styleguide_pagesGet styleguide pages
zeplin_design_update_project_componentUpdate a project component
zeplin_design_update_screenUpdate a screen
zeplin_design_update_screen_annotationUpdate an annotation
zeplin_design_update_screen_commentUpdate comment
zeplin_design_update_screen_noteUpdate a note
zeplin_design_update_styleguide_componentUpdate a styleguide component

zeplin_design_create_screen

Create a new screen Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
commit_colorstringNoCommit color for the screen version
commit_messagestringNoCommit message for the screen version
descriptionstringNoDescription for the screen
imagestringYesBinary data of the screen image. The image has to be in JPEG or PNG format, and its size cannot exceed 5MB.
namestringYesName of the screen
section_idstringNoUnique id of the screen section
tagsstring[]NoTags for the screen

zeplin_design_create_screen_annotation

Create an annotation Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
contentstringYesContent of the annotation
positionobjectYesPosition of the annotation with respect to top left corner. Values are normalized in [0, 1]
typestringNoThe unique id of the annotation type

zeplin_design_create_screen_comment

Create a comment Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
note_idstringYesScreen note id
contentstringYesContent of the comment

zeplin_design_create_screen_note

Create a note Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
colorstringYesThe color value
contentstringYesContent of the first comment of the note
positionobjectYesPosition of the note with respect to top left corner. Values are normalized in [0, 1]

zeplin_design_create_screen_version

Create a new screen version Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
commit_colorstringNoCommit color for the screen version
commit_messagestringNoCommit message for the screen version
imagestringYesBinary data of the screen image. The image has to be in JPEG or PNG format, and its size cannot exceed 5MB.

zeplin_design_delete_screen_annotation

Delete an annotation Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
annotation_idstringYesScreen annotation id

zeplin_design_delete_screen_comment

Delete comment Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
note_idstringYesScreen note id
comment_idstringYesScreen comment id

zeplin_design_delete_screen_note

Delete a note Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
note_idstringYesScreen note id

zeplin_design_get_latest_screen_version

Get the latest screen version Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id

zeplin_design_get_project_component

Get a single project component Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
component_idstringYesComponent id
include_latest_versionbooleanNoWhether to include the latest version data in the Component object
include_linked_styleguidesbooleanNoWhether to include linked styleguides or not

zeplin_design_get_project_component_latest_version

Get latest project component version Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
component_idstringYesComponent id
include_linked_styleguidesbooleanNoWhether to include linked styleguides or not

zeplin_design_get_project_component_sections

Get project component sections Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
page_idstringNoFilter by page id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_project_components

Get project components Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
section_idstringNoFilter by section id
sortstringNoSort components by their section or their created date
include_latest_versionbooleanNoWhether to include the latest version data in the Component object
include_linked_styleguidesbooleanNoWhether to include linked styleguides or not
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_project_connected_components

Get project connected components Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
limitintegerNoPagination limit
offsetintegerNoPagination offset
include_linked_styleguidesbooleanNoWhether to include linked styleguides or not

zeplin_design_get_project_flow_board

Get a single project flow board Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
flow_board_idstringYesFlow Board id

zeplin_design_get_project_flow_board_connector

Get a single project flow board connector Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
flow_board_idstringYesFlow Board id
connector_idstringYesBoard connector id

zeplin_design_get_project_flow_board_connectors

Get project flow board connectors Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
flow_board_idstringYesFlow Board id
starting_node_idstringNoStarting node id
ending_node_idstringNoEnding node id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_project_flow_board_groups

Get project flow board groups Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
flow_board_idstringYesFlow Board id

zeplin_design_get_project_flow_board_node

Get a single project flow board node Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
flow_board_idstringYesFlow Board id
node_idstringYesBoard node id

zeplin_design_get_project_flow_board_nodes

Get project flow board nodes Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
flow_board_idstringYesFlow Board id
group_idstringNoGroup id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_project_flow_boards

Get project flow boards Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id

zeplin_design_get_project_pages

Get project pages Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_project_screens

Get project screens Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
section_idstringNoFilter by section id
sortstringNoSort screens by their section or their created date
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_screen

Get a single screen Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id

zeplin_design_get_screen_annotation

Get a single screen annotation Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
annotation_idstringYesScreen annotation id

zeplin_design_get_screen_annotations

Get screen annotations Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_screen_annotations_note_types

Get screen annotation note types Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id

zeplin_design_get_screen_components

Get screen components Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
limitintegerNoPagination limit
offsetintegerNoPagination offset
include_latest_versionbooleanNoWhether to include the latest version data in the Component object
include_linked_styleguidesbooleanNoWhether to include linked styleguides or not

zeplin_design_get_screen_note

Get a single screen note Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
note_idstringYesScreen note id

zeplin_design_get_screen_notes

Get screen notes Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_screen_section

Get a single screen section Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
section_idstringYesScreen section id

zeplin_design_get_screen_sections

Get screen sections Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_screen_variant

Get a single screen variant Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
variant_idstringYesScreen variant id

zeplin_design_get_screen_variants

Get screen variants Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_screen_version

Get a single screen version Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
version_idstringYesScreen version id

zeplin_design_get_screen_versions

Get screen versions Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_styleguide_component

Get a single styleguide component Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
component_idstringYesComponent id
linked_projectstringNoReference project id
linked_styleguidestringNoReference styleguide id
include_latest_versionbooleanNoWhether to include the latest version data in the Component object
include_linked_styleguidesbooleanNoWhether to include linked styleguides or not

zeplin_design_get_styleguide_component_latest_version

Get latest styleguide component version Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
component_idstringYesComponent id
linked_projectstringNoReference project id
linked_styleguidestringNoReference styleguide id
include_linked_styleguidesbooleanNoWhether to include linked styleguides or not

zeplin_design_get_styleguide_component_sections

Get styleguide component sections Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
page_idstringNoFilter by page id
limitintegerNoPagination limit
offsetintegerNoPagination offset
linked_projectstringNoReference project id
linked_styleguidestringNoReference styleguide id

zeplin_design_get_styleguide_components

Get styleguide components Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
section_idstringNoFilter by section id
sortstringNoSort components by their section or their created date
linked_projectstringNoReference project id
linked_styleguidestringNoReference styleguide id
include_linked_styleguidesbooleanNoWhether to include linked styleguides or not
include_latest_versionbooleanNoWhether to include the latest version data in the Component object
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_get_styleguide_connected_components

Get styleguide connected components Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
limitintegerNoPagination limit
offsetintegerNoPagination offset
linked_projectstringNoReference project id
linked_styleguidestringNoReference styleguide id
include_linked_styleguidesbooleanNoWhether to include linked styleguides or not

zeplin_design_get_styleguide_pages

Get styleguide pages Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_design_update_project_component

Update a project component Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
component_idstringYesComponent id
descriptionstringYesNew description for component

zeplin_design_update_screen

Update a screen Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
descriptionstringNoNew description for screen
tagsstring[]NoNew tags for the screen

zeplin_design_update_screen_annotation

Update an annotation Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
annotation_idstringYesScreen annotation id
contentstringNoContent of the annotation
positionobjectNoPosition of the annotation with respect to top left corner. Values are normalized in [0, 1]
typestringNoThe unique id of the annotation type

zeplin_design_update_screen_comment

Update comment Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
note_idstringYesScreen note id
comment_idstringYesScreen comment id
contentstringYesContent of the comment

zeplin_design_update_screen_note

Update a note Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
screen_idstringYesScreen id
note_idstringYesScreen note id
colorstringNoThe color value
positionobjectNoPosition of the note with respect to top left corner. Values are normalized in [0, 1]
statusstringNoStatus of the note

zeplin_design_update_styleguide_component

Update a styleguide component Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
component_idstringYesComponent id
descriptionstringYesNew description for component