Skip to main content
Zeplin logo
  • Category: images & design
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? Yes
  • Tools: 24
  • Triggers: 0
  • Slug: ZEPLIN
  • Version: 20261101_00

Tools

Slug: ZEPLIN_AUTH_O_AUTH_AUTHORIZEConstruct an OAuth 2.0 authorization URL for a Zeplin app to initiate the authorization code flow.

Input Parameters

string
Random string for CSRF protection; echoed back in the callback.
string
required
Identifier of your Zeplin app (provided by Zeplin).
string
required
Whitelisted redirect URI registered in Zeplin. Must be a valid URI.
string
Must be ‘code’ to initiate authorization code flow.
string
PKCE code challenge derived from code_verifier.
string ("plain" | "S256")
Transformation method used to generate the code_challenge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_CONNECTED_COMPONENTS_PROJECT_LISTList connected components in a Zeplin project by project ID. Use limit and offset to page through the project’s connected code components. An empty list can also result from an unsuccessful response.

Input Parameters

integer
Number of connected components to return per page (1-100)
integer
Zero-based offset for pagination
string
required
Unique ID of the Zeplin project to list connected components for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_PROJECT_COLORS_LISTList colors defined in a Zeplin project by project ID, for example to retrieve its color tokens. An empty list can indicate an error rather than a project with no colors.

Input Parameters

string
required
ID of the target project
string
Token type for Authorization header, typically ‘Bearer’
string
Access token value to include in Authorization header
string
Full Authorization header value. If provided, overrides token_type/access_token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_PROJECT_COLOR_UPDATETool to update a color in a Zeplin project. Use when you need to modify RGBA channels or source ID of an existing color after confirming the project and color IDs.

Input Parameters

number
Alpha (opacity) component of the color (0.0–1.0)
integer
Blue component of the color (0–255)
integer
Green component of the color (0–255)
integer
Red component of the color (0–255)
string
required
ID of the color to update
string
Optional identifier of the color in the source design tool
string
required
ID of the project containing the color to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_PROJECTS_GETGet a Zeplin project by ID to view details about a specific project.

Input Parameters

string
required
Unique ID of the Zeplin project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_PROJECTS_MEMBERS_INVITEInvite a user to a Zeplin project by handle, with an optional role. The response may contain fallback member details even if the invitation fails.

Input Parameters

string ("owner" | "admin" | "editor" | "member" | "alien" | "user")
Role to assign to the user in the project; one of owner, admin, editor, member, alien, user
string
required
Identifier of the user to invite; typically an email address or username
string
required
ID of the Zeplin project to invite the member into

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_PROJECT_TEXT_STYLES_LISTList text styles in a Zeplin project by project ID to retrieve its typography tokens. Results are paginated using limit and offset; an empty list can also result from an error response.

Input Parameters

integer
Number of items to return per page (1-100)
integer
Zero-based offset for pagination
string
required
ID of the target project
string
Token type for Authorization header, typically ‘Bearer’
string
Access token value to include in Authorization header
string
Full Authorization header value. If provided, overrides token_type/access_token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_PROJECT_TEXT_STYLE_UPDATEUpdate an existing text style in a Zeplin project by project and text style IDs. Supply the typography or color properties to change; only provided properties are sent. A failed request can return only the requested style ID without indicating the failure.

Input Parameters

object
required
Fields to update on the text style
string
required
ID of the project containing the text style
string
Overrides stored token type (e.g., ‘Bearer’)
string
Overrides stored access token
string
Full Authorization header value. Overrides token_type/access_token if provided
string
required
ID of the text style to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_SCREEN_ANNOTATION_DELETETool to delete a screen annotation in Zeplin. Use when you need to remove a specific annotation from a Zeplin screen given its IDs.

Input Parameters

string
required
ID of the Zeplin screen containing the annotation.
string
required
ID of the screen annotation to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_SCREEN_ANNOTATION_GETTool to fetch a single screen annotation. Use when you know the screen_id and annotation_id and need the detailed annotation data.

Input Parameters

string
required
Unique ID of the Zeplin screen containing the annotation.
string
required
Unique ID of the screen annotation to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_SCREEN_ANNOTATIONS_LISTList a page of annotations for a Zeplin screen by screen ID. Use a page size of 1 to 100 and an offset to navigate results. An empty list can indicate a failed request.

Input Parameters

integer
Number of annotations to return per page (1-100)
integer
Zero-based offset for pagination
string
required
Unique ID of the Zeplin screen to list annotations for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_SCREEN_ANNOTATIONS_UPDATEUpdate a screen annotation’s content, position, or type by screen and annotation IDs. API errors are returned inside the annotation result.

Input Parameters

object
Type identifier for a screen annotation note type.
string
New text/content for the annotation
object
Normalized position of a screen annotation.
string
required
ID of the Zeplin screen containing the annotation
string
required
ID of the annotation to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_SCREEN_COMPONENTS_LISTList components in a Zeplin screen by screen ID. Use limit and offset to page through results and optionally request the latest version data. An empty list can also result from an unsuccessful response.

Input Parameters

integer
Number of components to return per page (1-100)
integer
Zero-based offset for pagination
string
required
Unique ID of the Zeplin screen to list components for
boolean
Whether to include latest_version data for each component

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_SCREEN_SECTION_GETTool to get a single screen section. Use when you need to fetch detailed information of a screen section by its ID after confirming the project and section IDs.

Input Parameters

string
required
Unique ID of the Zeplin project containing the section.
string
required
Unique ID of the screen section to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_SCREEN_SECTIONS_LISTList screen sections in a Zeplin project by project ID. Use limit and offset to page through sections that group screens; an empty list can also result from an error response.

Input Parameters

integer
Number of screen sections to return per page (1-100).
integer
Zero-based offset to start returning screen sections.
string
required
Unique ID of the Zeplin project to list screen sections for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_SCREEN_VERSION_GETRetrieve a specific Zeplin screen version by screen and version IDs to inspect its snapshot metadata. An empty version object can indicate a failed request.

Input Parameters

string
required
Unique ID of the Zeplin screen containing the version.
string
required
Unique ID of the specific screen version to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_SCREEN_VERSIONS_CREATETool to create a new version of a screen. Use when uploading a new design snapshot (PNG or JPEG image) as a screen version. Requires a valid project_id, screen_id, and an image file. Optionally include a commit_message.

Input Parameters

object
required
Image file to upload as the new screen version. Supported formats: PNG, JPEG.
string
required
Unique ID of the screen to create a new version for.
string
required
Unique ID of the Zeplin project containing the screen.
string
Descriptive message for the screen version commit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_SCREEN_VERSIONS_LISTList a page of versions for a Zeplin screen to enumerate its past snapshots. Set the page size from 1 to 100 and use an offset to retrieve further pages. An empty list can also indicate an error.

Input Parameters

integer
Maximum number of versions to return per page (1-100)
integer
Zero-based index of the first version to return
string
required
Unique ID of the Zeplin screen to list versions for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_STYLEGUIDE_COLOR_CREATECreate a color token in a Zeplin styleguide. On an unsuccessful response, the returned color can contain the placeholder ID “unavailable” and request values rather than confirming creation.

Input Parameters

number
required
Alpha channel value (0–1)
integer
required
Blue channel value (0–255)
integer
required
Green channel value (0–255)
integer
required
Red channel value (0–255)
string
required
Name of the color
string
Token type for Authorization header, typically ‘Bearer’
string
Access token value to include in Authorization header
string
Full Authorization header value. If provided, overrides token_type/access_token
string
required
ID of the target styleguide

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_STYLEGUIDE_COLORS_LISTList color tokens in a Zeplin styleguide by styleguide ID. A linked project ID can be supplied when the requester may not otherwise have access to the styleguide. An empty list can indicate an error.

Input Parameters

string
Token type for Authorization header, typically ‘Bearer’
string
Access token value to include in Authorization header
string
Full Authorization header value. If provided, overrides token_type/access_token
string
required
ID of the target styleguide
string
Optional project ID to grant access when requester may not be authorized to view the styleguide

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_STYLEGUIDE_COLOR_UPDATEUpdate a color in a Zeplin styleguide. An unsuccessful response can return only the requested color ID, which does not confirm the update.

Input Parameters

number
Alpha component (0.0–1.0)
integer
Blue component (0–255)
integer
Green component (0–255)
integer
Red component (0–255)
string
Name of the color
string
required
ID of the color to update
string
Design tool/source identifier of the color
string
Token type to use in Authorization header, typically ‘Bearer’
string
Access token value for Authorization header
string
Full Authorization header value (e.g., ‘Bearer x.y.z’). Overrides token_type/access_token if provided
string
required
ID of the styleguide containing the color

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_STYLEGUIDE_TEXT_STYLES_LISTList a page of text styles in a Zeplin styleguide to retrieve its typography tokens. Use a page size of 1 to 100 and an offset to navigate results; a linked project ID can also be supplied. An empty list can indicate an error.

Input Parameters

integer
Number of items to return per page (1-100)
integer
Zero-based offset for pagination
string
Token type for Authorization header, typically ‘Bearer’
string
Access token value to include in Authorization header
string
Full Authorization header value. If provided, overrides token_type/access_token
string
required
ID of the target styleguide
string
Optional project ID to filter linked text styles

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_STYLEGUIDE_TEXT_STYLE_UPDATEUpdate typography settings of a text style in a Zeplin styleguide. An unsuccessful response can return only the requested text style ID, which does not confirm the update.

Input Parameters

object
required
Fields to update on the text style
string
Overrides stored token type (e.g., ‘Bearer’)
string
Overrides stored access token
string
Full Authorization header value. Overrides token_type/access_token if provided
string
required
ID of the styleguide containing the text style
string
required
ID of the text style to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZEPLIN_USERS_GET_PERSONAL_PROJECTSList a page of projects in the current user’s personal workspace. Use limit and offset to navigate results; the default page size is 30 and the maximum is 100. An empty list can also result from an error response.

Input Parameters

integer
Number of items to return; default 30; maximum 100.
integer
Zero-based starting index; default 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not