Zeplin
API integration

list_all_zeplin_me

Get details of the current user in Zeplin. Returns id, email, username, emotar, avatar, and last_seen fields in the response.

list_all_zeplin_organizations

List organizations the user is a member of in Zeplin. Returns id, name, and logo for each organization.

get_single_zeplin_organization_by_id

Get details of a specific organization in Zeplin. Requires id. Returns id, name, and members with user details, role, tags, restricted status, and invited timestamp.

list_all_zeplin_members

List all members in an organization in Zeplin. Requires organization_id. Returns user details (id, email, username, avatar, last_seen), role, tags, restricted status, and invited timestamp.

create_a_zeplin_member

Invite a new member to an organization in Zeplin. Requires organization_id. Returns member details including user info (id, email, username, avatar, last_seen), role, tags, restricted status, and invited timestamp.

update_a_zeplin_member_by_id

Update a specific member in Zeplin. Requires organization_id and id. Updates role, restricted access, and tags. Returns no content on success.

delete_a_zeplin_member_by_id

Delete a member from an organization in Zeplin. Requires organization_id and id. Returns no content on success.

list_all_zeplin_project_members

List project_members in Zeplin. Requires project_id. Returns user details (id, email, username, avatar, last_seen) and role for each member.

create_a_zeplin_project_member

Invite a project_member to a project in Zeplin. Requires project_id. Returns no content on success.

delete_a_zeplin_project_member_by_id

Remove a project member in Zeplin. Requires project_id and id. Returns no content on success, or error messages with details if the project is archived, locked, not found, or if attempting to remove owner.

list_all_zeplin_projects

List all projects in Zeplin that the user is a member of. Returns project details including id, name, description, platform, status, created and updated timestamps, organization info, workflow_status, and resource counts.

get_single_zeplin_project_by_id

Get a project in Zeplin by id. Returns fields including id, name, description, platform, thumbnail, status, scene_url, created, updated, number_of_members, number_of_screens, number_of_components, number_of_connected_components, number_of_text_styles, number_of_colors, and linked_styleguide.

update_a_zeplin_project_by_id

Update a project in Zeplin. Requires id. Returns no content in the response upon success.

get_single_zeplin_organization_billing_by_id

Get organization billing details in Zeplin using organization_id. Returns total_seat_count and used_seat_count in the response.

list_all_zeplin_organization_projects

List projects in Zeplin for a given organization_id. Returns project id, name, description, platform, status, created, updated, organization details, workflow status, and counts of members, screens, components, text styles, colors, and spacing tokens.

list_all_zeplin_organization_workflow_statuses

List workflow statuses in Zeplin for a given organization_id. Returns id, name, and color (name, r, g, b, a) fields in the response.

list_all_zeplin_organization_styleguides

List styleguides in Zeplin for an organization using organization_id. Returns id, name, description, platform, status, created, updated, organization info, and counts of members, components, text styles, colors, and spacing tokens.

list_all_zeplin_organization_aliens

List all aliens in an organization in Zeplin. Requires organization_id. Returns user details including id, email, username, emotar, avatar, and last_seen.

list_all_zeplin_organization_member_projects

Get projects for a specific member in Zeplin. Requires organization_id and member_id. Returns project details including id, name, description, platform, status, created, updated, number_of_members, number_of_screens, number_of_components, and linked_styleguide.

list_all_zeplin_organization_member_styleguides

Get styleguides for a member in Zeplin. Requires organization_id and id. Returns styleguide details including id, name, description, platform, thumbnail, status, created, updated, number_of_members, number_of_components, number_of_text_styles, number_of_colors, and parent id.

list_all_zeplin_organization_webhooks

List organization webhooks in Zeplin. Requires organization_id. Returns id, name, status, created, created_by, updated, updated_by, url, url_health, events, project_ids, and styleguide_ids.

get_single_zeplin_organization_webhook_by_id

Get a webhook in Zeplin by organization_id and id. Returns fields including id, name, status, created, created_by, updated, updated_by, url, url_health, events, project_ids, and styleguide_ids.

create_a_zeplin_organization_webhook

Create an organization webhook in Zeplin. Requires organization_id, events, project_ids, styleguide_ids, url, and secret. Returns id of the created webhook in response.

update_a_zeplin_organization_webhook_by_id

Update an organization webhook in Zeplin. Requires organization_id and id. Returns no content if successful.

delete_a_zeplin_organization_webhook_by_id

Delete a webhook in Zeplin by organization_id and id. Returns no content on success. Errors may include organization not found, webhook not found, or insufficient permissions.

list_all_zeplin_project_webhooks

List project webhooks in Zeplin. Requires project_id. Returns id, name, status, created, created_by, updated, updated_by, url, url_health, and events for each webhook.

get_single_zeplin_project_webhook_by_id

Get a webhook in Zeplin by project_id and id. Returns webhook details including id, name, status, created, created_by, updated, updated_by, url, url_health, and events in the response.

create_a_zeplin_project_webhook

Create a webhook for a project in Zeplin. Requires project_id. Returns id of the created webhook. Note: Users authorized before webhooks release must re-authorize the app to create webhooks.

update_a_zeplin_project_webhook_by_id

Update a specific project webhook in Zeplin. Requires project_id and id. Returns no content on success.

delete_a_zeplin_project_webhook_by_id

Delete a webhook in Zeplin for a specific project. Requires project_id and id. Returns no content on success; errors include message, detail, and code if project or webhook is not found, user lacks access, or project is archived.

list_all_zeplin_styleguide_webhooks

List styleguide webhooks in Zeplin using styleguide_id. Returns webhook fields including id, name, status, created, created_by, updated, updated_by, url, url_health, and events.

get_single_zeplin_styleguide_webhook_by_id

Get a specific styleguide webhook in Zeplin by styleguide_id and id. Returns fields such as id, name, status, created, created_by, updated, updated_by, url, url_health, and events.

create_a_zeplin_styleguide_webhook

Create a webhook for a styleguide in Zeplin. Requires styleguide_id. Returns id of the created webhook in the response. Users authorized before webhooks release must re-authorize the app.

update_a_zeplin_styleguide_webhook_by_id

Update a webhook for a styleguide in Zeplin. Requires styleguide_id and id. Returns no content on success.

delete_a_zeplin_styleguide_webhook_by_id

Delete a specific styleguide webhook in Zeplin. Requires styleguide_id and id. Returns no content on success.

list_all_zeplin_user_webhooks

List all user webhooks in Zeplin. Returns id, name, status, created, created_by, updated, updated_by, url, url_health, events, project_ids, and styleguide_ids for each webhook. Zeplin apps can only list webhooks created by them; listing all requires a personal access token.

get_single_zeplin_user_webhook_by_id

Get a user webhook in Zeplin by id. Requires id. Returns details including id, name, status, url, created, updated, created_by, updated_by, url_health, events, project_ids, and styleguide_ids.

create_a_zeplin_user_webhook

Create a webhook for the user in Zeplin. Requires events, project_ids, styleguide_ids, url, and secret. Returns id of the created webhook. Wildcard '*' can be used for project_ids and styleguide_ids. Users authorized before webhooks release must re-authorize to create webhooks.

update_a_zeplin_user_webhook_by_id

Update a user webhook in Zeplin. Requires id. Returns no content on success.

delete_a_zeplin_user_webhook_by_id

Delete a specific user webhook in Zeplin using id. Returns no content on success. Errors include 'User cannot delete webhook' and 'Webhook not found'.

list_all_zeplin_project_colors

List project colors in Zeplin. Requires project_id. Returns id, name, rgba values, created timestamp, source_id, variable_info, and source project details.

create_a_zeplin_project_color

Create a project color in Zeplin. Requires project_id. Returns the new color's id in the response.

update_a_zeplin_project_color_by_id

Update a project color in Zeplin. Requires project_id and id. Returns no content on success.

list_all_zeplin_styleguide_colors

Get styleguide colors in Zeplin. Requires styleguide_id. Returns fields including id, name, rgba values, variable_info, and source details.

create_a_zeplin_styleguide_color

Create a styleguide color in Zeplin. Requires styleguide_id. Returns an object reference with the id of the newly created color.

update_a_zeplin_styleguide_color_by_id

Update a specific styleguide color in Zeplin. Requires styleguide_id and id. Returns no content if successful, or error details including message, detail, and code on failure.

list_all_zeplin_project_text_styles

List all text styles in a project's local styleguide in Zeplin. Requires project_id. Returns fields including id, name, created, postscript_name, font_family, font_size, font_weight, font_style, line_height, font_stretch, text_align, color details, and source project information.

update_a_zeplin_project_text_style_by_id

Update a project text style in Zeplin using project_id and id. Returns no content on success.

list_all_zeplin_styleguide_text_styles

Get styleguide text styles in Zeplin. Requires styleguide_id. Returns text styles with fields including id, name, created, font details, text_align, color values and source project details.

update_a_zeplin_styleguide_text_style_by_id

Update a styleguide text style in Zeplin using styleguide_id and id. Returns no content on success.

list_all_zeplin_project_connected_components

List all connected components of a project in Zeplin. Requires project_id. Returns fields including id of components, name, description, code snippet with language, and related links.

list_all_zeplin_styleguide_connected_components

List all connected components in Zeplin for a given styleguide_id. Returns name, description, components with id, code snippet and language, and related links.

list_all_zeplin_project_components

List components in a project in Zeplin. Requires project_id. Returns component fields including id, name, description, image (with thumbnails), created, updated, section details, source project, and variant_properties.

get_single_zeplin_project_component_by_id

Get a project component in Zeplin by project_id and id. Returns fields such as id, name, description, image details (width, height, URLs), created, updated, section info, source project info, and variant_properties.

update_a_zeplin_project_component_by_id

Update a project component description in Zeplin. Requires project_id and id. Returns no content on success.

get_single_zeplin_project_component_latest_version_by_id

Get latest version of a project component in Zeplin. Requires project_id and id. Returns fields such as id, created, creator (id, email, username, avatar, last_seen), image_url, thumbnails, width, height, density_scale, source, background_color, links, layers, and assets.

list_all_zeplin_project_pages

List all pages in a Zeplin project. Requires project_id. Returns page id, created timestamp, name, type, description, and componentSections.

list_all_zeplin_project_component_sections

List project component-sections in Zeplin. Requires project_id. Returns id, name, description, and order fields for each component-section.

list_all_zeplin_styleguide_components

Get components in a styleguide in Zeplin. Requires styleguide_id. Returns id, name, description, image details, created, updated, section info, source project, and variant_properties in the response.

get_single_zeplin_styleguide_component_by_id

Get a specific styleguide component in Zeplin. Requires styleguide_id and id. Returns fields including id, name, description, image details (URLs and sizes), created, updated, section, source project info, and variant_properties.

update_a_zeplin_styleguide_component_by_id

Update a styleguide component in Zeplin. Requires styleguide_id and id. Updates the component's description. Response returns no content if successful, or error fields message, detail, and code if update fails.

get_single_zeplin_styleguide_component_version_by_id

Get the latest styleguide component version in Zeplin. Requires styleguide_id and id. Returns fields including id, created timestamp, creator details, image_url, thumbnails, dimensions, layers, and assets.

list_all_zeplin_styleguide_component_sections

Get component sections of a styleguide in Zeplin. Requires styleguide_id. Returns fields including id (unique identifier), created (timestamp), name (section name), groups (group details), and variant (properties and source_id).

list_all_zeplin_styleguide_pages

List all pages of a styleguide in Zeplin. Requires styleguide_id. Returns id, created timestamp, name, type, description, and componentSections for each page.

list_all_zeplin_project_spacing_tokens

List spacing tokens of a project in Zeplin. Requires project_id. Returns id, name, value, color (RGBA), section.id, and source.project details including linked_styleguide.id.

update_a_zeplin_project_spacing_token_by_id

Update a specific spacing token in a project's local styleguide in Zeplin. Requires project_id and id. Returns no content on success. Errors may include project not found, spacing token not found, insufficient permissions, or project archived.

list_all_zeplin_project_spacing_sections

List spacing sections in a project in Zeplin. Requires project_id. Returns id, name, and base_token.id for each spacing section.

list_all_zeplin_styleguide_spacing_tokens

List spacing tokens of a styleguide in Zeplin. Requires styleguide_id. Returns id, name, value, color (RGBA), section.id, and source.project details (id, name, platform, linked_styleguide.id).

update_a_zeplin_styleguide_spacing_token_by_id

Update a spacing token in a Zeplin styleguide. Requires styleguide_id and id. Returns no content on success.

list_all_zeplin_styleguide_spacing_section

List spacing sections in a styleguide in Zeplin. Requires styleguide_id. Returns id (unique identifier), name (section name), and base_token.id (linked base token).

list_all_zeplin_project_design_tokens

Get design tokens in Zeplin for a project using project_id. Returns colors with RGB values, spacing tokens with numeric values, and text styles with font, color, and line height metadata.

list_all_zeplin_styleguide_design_tokens

Get styleguide design tokens in Zeplin. Requires id. Returns design token details including colors with values and metadata, spacing with size details, and text styles with font properties from the specified styleguide.

list_all_zeplin_project_flow_boards

List flow boards in a project in Zeplin. Requires project_id. Returns id, name, number_of_connectors, number_of_nodes, and number_of_groups for each flow board.

get_single_zeplin_project_flow_board_by_id

Get a project flow board in Zeplin using project_id and id. Returns id, name, number_of_connectors, number_of_nodes, and number_of_groups in the response.

list_all_zeplin_project_flow_board_groups

List all flow board groups in a project in Zeplin. Requires project_id and flow_board_id. Returns group id, created timestamp, name, and color details (r,g,b,a,source_id).

list_all_zeplin_project_flow_board_connectors

List flow board connectors in Zeplin for a given project_id and flow_board_id. Returns connectors with fields such as id, type, start node and position, and end node with label metadata.

get_single_zeplin_project_flow_board_connector_by_id

Get details of a specific project flow board connector in Zeplin. Requires project_id, flow_board_id, and id. Returns connector fields including id, type, start node with position, and end node with label details.

list_all_zeplin_project_flow_board_nodes

List all flow board nodes in a project in Zeplin. Requires project_id and flow_board_id. Returns node id, type, screen id, and position (x, y).

get_single_zeplin_project_flow_board_node_by_id

Get details of a specific project flow board node in Zeplin using project_id, flow_board_id, and id. Returns id, type, screen.id, and position (x, y) in the response.

list_all_zeplin_project_variable_collections

Get project variable collections in Zeplin. Requires project_id. Returns collections with id, created, name, source_id, modes (variable modes), groups (variable groups) and variables including color values.

list_all_zeplin_styleguide_variable_collections

Get variable collections in a styleguide in Zeplin. Requires styleguide_id. Returns id, created timestamp, name, source_id, modes, groups, and variables with their color values.

list_all_zeplin_styleguides

List styleguides in Zeplin that the user is a member of. Returns fields like id, name, description, platform, status, created, updated, number_of_members, number_of_components, number_of_text_styles, number_of_colors, and parent id.

get_single_zeplin_styleguide_by_id

Get a specific styleguide in Zeplin using id. Returns fields including id, name, description, platform, thumbnail, status, created, updated, number_of_members, number_of_components, number_of_connected_components, number_of_text_styles, number_of_colors, and parent.id.

update_a_zeplin_styleguide_by_id

Update a styleguide in Zeplin. Requires id. Returns no content if successful. Allows updating name and description fields.

list_all_zeplin_styleguide_members

List members of a styleguide in Zeplin. Requires id. Returns user details (id, email, username, avatar, last_seen) and role for each member in the response.

create_a_zeplin_styleguide_member

Invite a member to a styleguide in Zeplin. Requires styleguide_id. Response returns no content on success. Errors include when styleguide is archived, locked, invitee already a member, or external members are disallowed.

delete_a_zeplin_styleguide_member_by_id

Remove a specific styleguide member in Zeplin. Requires styleguide_id and id. Returns no content on success.

list_all_zeplin_styleguide_linked_projects

List projects linked to a styleguide in Zeplin. Requires styleguide_id. Returns project details including id, name, description, platform, status, scene_url, member and screen counts, and linked_styleguide reference.

list_all_zeplin_personal_projects

List personal projects in Zeplin that belong to the current user. Returns projects with id, name, description, platform, thumbnail, status, scene_url, created, updated, member and asset counts, and linked_styleguide.

list_all_zeplin_personal_styleguides

List personal styleguides in Zeplin that belong to the current user. Returns id, name, description, platform, thumbnail, status, created, updated, number_of_members, number_of_components, number_of_connected_components, number_of_text_styles, number_of_colors, and parent.id.

list_all_zeplin_user_notifications

List user notifications in Zeplin. Returns notifications with fields such as id, timestamp, type, action, is_read, resource details, context project info, and actor user data.

get_single_zeplin_user_notification_by_id

Get a notification in Zeplin by id. Requires id. Returns fields including id, timestamp, type, action, is_read, resource details, context project info, and actor user data.

update_a_zeplin_user_notification_by_id

Update a user notification in Zeplin. Requires id. Returns no content on success or an error message if notification is not found.

zeplin_user_notifications_bulk_update

Update user notifications in Zeplin. Requires is_read in request body. Optionally filter by type or id, but not both. Returns no content on success.

list_all_zeplin_project_screens

List all screens of a project in Zeplin. Requires project_id. Returns an array of screens with fields: id, name, description, tags, image details (with thumbnails), created, updated, number_of_notes, number_of_versions, number_of_annotations, section, and variant information.

get_single_zeplin_project_screen_by_id

Get a specific project-screen in Zeplin by project_id and id. Returns fields such as id, name, description, tags, image details, created, updated, number_of_notes, number_of_versions, number_of_annotations, section, and variant.

create_a_zeplin_project_screen

Create a new screen in a Zeplin project. Requires project_id, name, and image. Returns the id of the created screen in the response.

update_a_zeplin_project_screen_by_id

Update a screen in Zeplin. Requires project_id and id. Updates the screen's description or tags. Returns no content on success.

list_all_zeplin_screen_components

List components in a specific screen in Zeplin. Requires project_id and screen_id. Returns component fields including id, name, description, image details (width, height, original_url, thumbnails), created, updated, section, source project, and variant_properties.

list_all_zeplin_screen_notes

List all notes in a screen in Zeplin. Requires project_id and screen_id. Returns note id, created timestamp, order, status, position, color, creator details, and comments with authors, content, updates, reactions, and screen_version_id.

get_single_zeplin_screen_note_by_id

Get a screen note in Zeplin by project_id, screen_id, and id. Returns fields such as id, created, order, status, position, color, creator details, and comments with authors, content, reactions, and related screen_version_id.

create_a_zeplin_screen_note

Create a note on a screen in Zeplin. Requires project_id and screen_id. Returns id of the created note in the response.

update_a_zeplin_screen_note_by_id

Update a specific screen note in Zeplin. Requires project_id, screen_id, and id. Returns no content on success. Errors may indicate project, screen, or note not found, or user not a member or project archived.

delete_a_zeplin_screen_note_by_id

Delete a specific screen note in Zeplin. Requires project_id, screen_id, and id. Returns no content on success.

create_a_zeplin_screen_comment

Create a comment on a screen note in Zeplin. Requires project_id, screen_id, and note_id. Returns id of the created comment in the response.

update_a_zeplin_screen_comment_by_id

Update a specific screen comment in Zeplin using project_id, screen_id, note_id, and id. Returns no content on success.

delete_a_zeplin_screen_comment_by_id

Delete a specific screen comment in Zeplin by providing project_id, screen_id, note_id, and id. Returns no content on success.

list_all_zeplin_screen_annotations

List all screen-annotations in Zeplin for a given project_id and screen_id. Returns id, content, type details (id, name, color), position, creator info (id, email, username, avatar), updated, and created timestamps in the response.

get_single_zeplin_screen_annotation_by_id

Get a screen annotation in Zeplin by project_id, screen_id, and id. Returns id, content, type details (id, name, color), position, creator details (id, email, username, avatar, last_seen), and timestamps (updated, created).

create_a_zeplin_screen_annotation

Create an annotation on a screen in Zeplin. Requires project_id and screen_id. Returns id of the created annotation in the response.

update_a_zeplin_screen_annotation_by_id

Update a specific screen annotation in Zeplin. Requires project_id, screen_id, and id. Returns no content on success.

delete_a_zeplin_screen_annotation_by_id

Delete a specific screen annotation in Zeplin. Requires project_id, screen_id, and id. Returns no content on success.

list_all_zeplin_screen_annotation_note_types

List screen annotation note types in Zeplin for a project using project_id. Returns id, name, and color details (name, r, g, b, a) for each note type.

list_all_zeplin_screen_versions

List all versions of a screen in Zeplin. Requires project_id and screen_id. Returns screen version summaries including id, creator, commit details, image_url, thumbnails, dimensions, background_color, and links.

get_single_zeplin_screen_version_by_id

Get details of a specific screen version in Zeplin. Requires project_id, screen_id, and id. Returns fields such as id, creator details, commit info, image_url, thumbnails, dimensions, background_color, links, layers, and assets.

create_a_zeplin_screen_version

Create a new screen version in Zeplin. Requires project_id and screen_id. Returns object reference with id of the created screen version.

get_single_zeplin_latest_screen_version_by_id

Get the latest screen version in Zeplin for a specific project. Requires project_id and id. Returns version id, creator details, commit info, image_url, thumbnails, dimensions, background_color, links, layers, and assets.

list_all_zeplin_screen_sections

List all screen sections in Zeplin for a project. Requires project_id. Returns section fields including id, created timestamp, name, and parent.id in the response.

get_single_zeplin_screen_section_by_id

Get a screen section in Zeplin by project_id and id. Returns id, created timestamp, name, and parent object with id in the response.

list_all_zeplin_screen_variants

List all screen variants in Zeplin for the given project_id. Returns an array of screen variant groups with fields: id (variant group id), name (variant group name), and variants (array of screen_id and value).

get_single_zeplin_screen_variant_by_id

Get a screen variant in Zeplin by project_id and id. Returns id, name, and variants with screen_id and value in the response.