/zeplin-design | Type: Application | PCID required: Yes
Tools
zeplin_design_create_screen
Create a new screen Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
commit_color | string | No | — | Commit color for the screen version |
commit_message | string | No | — | Commit message for the screen version |
description | string | No | — | Description for the screen |
image | string | Yes | — | Binary data of the screen image. The image has to be in JPEG or PNG format, and its size cannot exceed 5MB. |
name | string | Yes | — | Name of the screen |
section_id | string | No | — | Unique id of the screen section |
tags | string[] | No | — | Tags for the screen |
zeplin_design_create_screen_annotation
Create an annotation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
content | string | Yes | — | Content of the annotation |
position | object | Yes | — | Position of the annotation with respect to top left corner. Values are normalized in [0, 1] |
type | string | No | — | The unique id of the annotation type |
zeplin_design_create_screen_comment
Create a comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
note_id | string | Yes | — | Screen note id |
content | string | Yes | — | Content of the comment |
zeplin_design_create_screen_note
Create a note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
color | string | Yes | — | The color value |
content | string | Yes | — | Content of the first comment of the note |
position | object | Yes | — | Position 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
commit_color | string | No | — | Commit color for the screen version |
commit_message | string | No | — | Commit message for the screen version |
image | string | Yes | — | Binary 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
annotation_id | string | Yes | — | Screen annotation id |
zeplin_design_delete_screen_comment
Delete comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
note_id | string | Yes | — | Screen note id |
comment_id | string | Yes | — | Screen comment id |
zeplin_design_delete_screen_note
Delete a note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
note_id | string | Yes | — | Screen note id |
zeplin_design_get_latest_screen_version
Get the latest screen version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
zeplin_design_get_project_component
Get a single project component Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
component_id | string | Yes | — | Component id |
include_latest_version | boolean | No | — | Whether to include the latest version data in the Component object |
include_linked_styleguides | boolean | No | — | Whether to include linked styleguides or not |
zeplin_design_get_project_component_latest_version
Get latest project component version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
component_id | string | Yes | — | Component id |
include_linked_styleguides | boolean | No | — | Whether to include linked styleguides or not |
zeplin_design_get_project_component_sections
Get project component sections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
page_id | string | No | — | Filter by page id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_project_components
Get project components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
section_id | string | No | — | Filter by section id |
sort | string | No | — | Sort components by their section or their created date |
include_latest_version | boolean | No | — | Whether to include the latest version data in the Component object |
include_linked_styleguides | boolean | No | — | Whether to include linked styleguides or not |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_project_connected_components
Get project connected components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
include_linked_styleguides | boolean | No | — | Whether to include linked styleguides or not |
zeplin_design_get_project_flow_board
Get a single project flow board Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
flow_board_id | string | Yes | — | Flow Board id |
zeplin_design_get_project_flow_board_connector
Get a single project flow board connector Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
flow_board_id | string | Yes | — | Flow Board id |
connector_id | string | Yes | — | Board connector id |
zeplin_design_get_project_flow_board_connectors
Get project flow board connectors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
flow_board_id | string | Yes | — | Flow Board id |
starting_node_id | string | No | — | Starting node id |
ending_node_id | string | No | — | Ending node id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_project_flow_board_groups
Get project flow board groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
flow_board_id | string | Yes | — | Flow Board id |
zeplin_design_get_project_flow_board_node
Get a single project flow board node Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
flow_board_id | string | Yes | — | Flow Board id |
node_id | string | Yes | — | Board node id |
zeplin_design_get_project_flow_board_nodes
Get project flow board nodes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
flow_board_id | string | Yes | — | Flow Board id |
group_id | string | No | — | Group id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_project_flow_boards
Get project flow boards Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
zeplin_design_get_project_pages
Get project pages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_project_screens
Get project screens Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
section_id | string | No | — | Filter by section id |
sort | string | No | — | Sort screens by their section or their created date |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_screen
Get a single screen Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
zeplin_design_get_screen_annotation
Get a single screen annotation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
annotation_id | string | Yes | — | Screen annotation id |
zeplin_design_get_screen_annotations
Get screen annotations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_screen_annotations_note_types
Get screen annotation note types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
zeplin_design_get_screen_components
Get screen components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
include_latest_version | boolean | No | — | Whether to include the latest version data in the Component object |
include_linked_styleguides | boolean | No | — | Whether to include linked styleguides or not |
zeplin_design_get_screen_note
Get a single screen note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
note_id | string | Yes | — | Screen note id |
zeplin_design_get_screen_notes
Get screen notes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_screen_section
Get a single screen section Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
section_id | string | Yes | — | Screen section id |
zeplin_design_get_screen_sections
Get screen sections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_screen_variant
Get a single screen variant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
variant_id | string | Yes | — | Screen variant id |
zeplin_design_get_screen_variants
Get screen variants Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_screen_version
Get a single screen version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
version_id | string | Yes | — | Screen version id |
zeplin_design_get_screen_versions
Get screen versions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_styleguide_component
Get a single styleguide component Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
component_id | string | Yes | — | Component id |
linked_project | string | No | — | Reference project id |
linked_styleguide | string | No | — | Reference styleguide id |
include_latest_version | boolean | No | — | Whether to include the latest version data in the Component object |
include_linked_styleguides | boolean | No | — | Whether to include linked styleguides or not |
zeplin_design_get_styleguide_component_latest_version
Get latest styleguide component version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
component_id | string | Yes | — | Component id |
linked_project | string | No | — | Reference project id |
linked_styleguide | string | No | — | Reference styleguide id |
include_linked_styleguides | boolean | No | — | Whether to include linked styleguides or not |
zeplin_design_get_styleguide_component_sections
Get styleguide component sections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
page_id | string | No | — | Filter by page id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
linked_project | string | No | — | Reference project id |
linked_styleguide | string | No | — | Reference styleguide id |
zeplin_design_get_styleguide_components
Get styleguide components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
section_id | string | No | — | Filter by section id |
sort | string | No | — | Sort components by their section or their created date |
linked_project | string | No | — | Reference project id |
linked_styleguide | string | No | — | Reference styleguide id |
include_linked_styleguides | boolean | No | — | Whether to include linked styleguides or not |
include_latest_version | boolean | No | — | Whether to include the latest version data in the Component object |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_get_styleguide_connected_components
Get styleguide connected components Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
linked_project | string | No | — | Reference project id |
linked_styleguide | string | No | — | Reference styleguide id |
include_linked_styleguides | boolean | No | — | Whether to include linked styleguides or not |
zeplin_design_get_styleguide_pages
Get styleguide pages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
zeplin_design_update_project_component
Update a project component Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
component_id | string | Yes | — | Component id |
description | string | Yes | — | New description for component |
zeplin_design_update_screen
Update a screen Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
description | string | No | — | New description for screen |
tags | string[] | No | — | New tags for the screen |
zeplin_design_update_screen_annotation
Update an annotation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
annotation_id | string | Yes | — | Screen annotation id |
content | string | No | — | Content of the annotation |
position | object | No | — | Position of the annotation with respect to top left corner. Values are normalized in [0, 1] |
type | string | No | — | The unique id of the annotation type |
zeplin_design_update_screen_comment
Update comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
note_id | string | Yes | — | Screen note id |
comment_id | string | Yes | — | Screen comment id |
content | string | Yes | — | Content of the comment |
zeplin_design_update_screen_note
Update a note Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
screen_id | string | Yes | — | Screen id |
note_id | string | Yes | — | Screen note id |
color | string | No | — | The color value |
position | object | No | — | Position of the note with respect to top left corner. Values are normalized in [0, 1] |
status | string | No | — | Status of the note |
zeplin_design_update_styleguide_component
Update a styleguide component Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
component_id | string | Yes | — | Component id |
description | string | Yes | — | New description for component |

