> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Zeplin

> Zeplin is a design delivery platform that connects designers and developers, enabling access to design resources like projects, screens, components, and assets.

![Zeplin logo](https://mintcdn.com/composio-preview/11RkPhDhzt1wdr6a/images/toolkits/zeplin.svg?fit=max\&auto=format\&n=11RkPhDhzt1wdr6a\&q=85\&s=5c5f39474bd1dfb406424eb70d8ee08a)

* **Category:** images & design
* **Auth:** OAUTH2, API\_KEY
* **Composio-managed OAuth available?** Yes
* **Tools:** 24
* **Triggers:** 0
* **Slug:** `ZEPLIN`
* **Version:** 20261101\_00

## Tools

> [accordion] Start OAuth authorization (PKCE)
>
> **Slug:** `ZEPLIN_AUTH_O_AUTH_AUTHORIZE`
>
> Construct an OAuth 2.0 authorization URL for a Zeplin app to initiate the authorization code flow.
>
> #### Input Parameters
>
> **state** `string`
>
> Random string for CSRF protection; echoed back in the callback.
>
> **client\_id** `string` *required*
>
> Identifier of your Zeplin app (provided by Zeplin).
>
> **redirect\_uri** `string` *required*
>
> Whitelisted redirect URI registered in Zeplin. Must be a valid URI.
>
> **response\_type** `string`
>
> Must be 'code' to initiate authorization code flow.
>
> **code\_challenge** `string`
>
> PKCE code challenge derived from code\_verifier.
>
> **code\_challenge\_method** `string ("plain" | "S256")`
>
> Transformation method used to generate the code\_challenge.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Project Connected Components
>
> **Slug:** `ZEPLIN_CONNECTED_COMPONENTS_PROJECT_LIST`
>
> List 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
>
> **limit** `integer`
>
> Number of connected components to return per page (1-100)
>
> **offset** `integer`
>
> Zero-based offset for pagination
>
> **project\_id** `string` *required*
>
> Unique ID of the Zeplin project to list connected components for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Project Colors
>
> **Slug:** `ZEPLIN_PROJECT_COLORS_LIST`
>
> List 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
>
> **project\_id** `string` *required*
>
> ID of the target project
>
> **token\_type** `string`
>
> Token type for Authorization header, typically 'Bearer'
>
> **access\_token** `string`
>
> Access token value to include in Authorization header
>
> **authorization** `string`
>
> Full Authorization header value. If provided, overrides token\_type/access\_token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Project Color
>
> **Slug:** `ZEPLIN_PROJECT_COLOR_UPDATE`
>
> Tool 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
>
> **a** `number`
>
> Alpha (opacity) component of the color (0.0–1.0)
>
> **b** `integer`
>
> Blue component of the color (0–255)
>
> **g** `integer`
>
> Green component of the color (0–255)
>
> **r** `integer`
>
> Red component of the color (0–255)
>
> **color\_id** `string` *required*
>
> ID of the color to update
>
> **source\_id** `string`
>
> Optional identifier of the color in the source design tool
>
> **project\_id** `string` *required*
>
> ID of the project containing the color to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zeplin Project by ID
>
> **Slug:** `ZEPLIN_PROJECTS_GET`
>
> Get a Zeplin project by ID to view details about a specific project.
>
> #### Input Parameters
>
> **project\_id** `string` *required*
>
> Unique ID of the Zeplin project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Invite Project Member
>
> **Slug:** `ZEPLIN_PROJECTS_MEMBERS_INVITE`
>
> Invite 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
>
> **role** `string ("owner" | "admin" | "editor" | "member" | "alien" | "user")`
>
> Role to assign to the user in the project; one of owner, admin, editor, member, alien, user
>
> **handle** `string` *required*
>
> Identifier of the user to invite; typically an email address or username
>
> **project\_id** `string` *required*
>
> ID of the Zeplin project to invite the member into
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Project Text Styles
>
> **Slug:** `ZEPLIN_PROJECT_TEXT_STYLES_LIST`
>
> List 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
>
> **limit** `integer`
>
> Number of items to return per page (1-100)
>
> **offset** `integer`
>
> Zero-based offset for pagination
>
> **project\_id** `string` *required*
>
> ID of the target project
>
> **token\_type** `string`
>
> Token type for Authorization header, typically 'Bearer'
>
> **access\_token** `string`
>
> Access token value to include in Authorization header
>
> **authorization** `string`
>
> Full Authorization header value. If provided, overrides token\_type/access\_token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Project Text Style
>
> **Slug:** `ZEPLIN_PROJECT_TEXT_STYLE_UPDATE`
>
> Update 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
>
> **data** `object` *required*
>
> Fields to update on the text style
>
> **project\_id** `string` *required*
>
> ID of the project containing the text style
>
> **token\_type** `string`
>
> Overrides stored token type (e.g., 'Bearer')
>
> **access\_token** `string`
>
> Overrides stored access token
>
> **authorization** `string`
>
> Full Authorization header value. Overrides token\_type/access\_token if provided
>
> **text\_style\_id** `string` *required*
>
> ID of the text style to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Screen Annotation
>
> **Slug:** `ZEPLIN_SCREEN_ANNOTATION_DELETE`
>
> Tool 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
>
> **screen\_id** `string` *required*
>
> ID of the Zeplin screen containing the annotation.
>
> **annotation\_id** `string` *required*
>
> ID of the screen annotation to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Screen Annotation
>
> **Slug:** `ZEPLIN_SCREEN_ANNOTATION_GET`
>
> Tool to fetch a single screen annotation. Use when you know the screen\_id and annotation\_id and need the detailed annotation data.
>
> #### Input Parameters
>
> **screen\_id** `string` *required*
>
> Unique ID of the Zeplin screen containing the annotation.
>
> **annotation\_id** `string` *required*
>
> Unique ID of the screen annotation to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Screen Annotations
>
> **Slug:** `ZEPLIN_SCREEN_ANNOTATIONS_LIST`
>
> List 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
>
> **limit** `integer`
>
> Number of annotations to return per page (1-100)
>
> **offset** `integer`
>
> Zero-based offset for pagination
>
> **screen\_id** `string` *required*
>
> Unique ID of the Zeplin screen to list annotations for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Screen Annotation
>
> **Slug:** `ZEPLIN_SCREEN_ANNOTATIONS_UPDATE`
>
> Update a screen annotation's content, position, or type by screen and annotation IDs. API errors are returned inside the annotation result.
>
> #### Input Parameters
>
> **type** `object`
>
> Type identifier for a screen annotation note type.
>
> **content** `string`
>
> New text/content for the annotation
>
> **position** `object`
>
> Normalized position of a screen annotation.
>
> **screen\_id** `string` *required*
>
> ID of the Zeplin screen containing the annotation
>
> **annotation\_id** `string` *required*
>
> ID of the annotation to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Screen Components
>
> **Slug:** `ZEPLIN_SCREEN_COMPONENTS_LIST`
>
> List 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
>
> **limit** `integer`
>
> Number of components to return per page (1-100)
>
> **offset** `integer`
>
> Zero-based offset for pagination
>
> **screen\_id** `string` *required*
>
> Unique ID of the Zeplin screen to list components for
>
> **include\_latest\_version** `boolean`
>
> Whether to include latest\_version data for each component
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Screen Section
>
> **Slug:** `ZEPLIN_SCREEN_SECTION_GET`
>
> Tool 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
>
> **project\_id** `string` *required*
>
> Unique ID of the Zeplin project containing the section.
>
> **section\_id** `string` *required*
>
> Unique ID of the screen section to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Screen Sections
>
> **Slug:** `ZEPLIN_SCREEN_SECTIONS_LIST`
>
> List 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
>
> **limit** `integer`
>
> Number of screen sections to return per page (1-100).
>
> **offset** `integer`
>
> Zero-based offset to start returning screen sections.
>
> **project\_id** `string` *required*
>
> Unique ID of the Zeplin project to list screen sections for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Screen Version
>
> **Slug:** `ZEPLIN_SCREEN_VERSION_GET`
>
> Retrieve 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
>
> **screen\_id** `string` *required*
>
> Unique ID of the Zeplin screen containing the version.
>
> **version\_id** `string` *required*
>
> Unique ID of the specific screen version to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Screen Version
>
> **Slug:** `ZEPLIN_SCREEN_VERSIONS_CREATE`
>
> Tool 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
>
> **image** `object` *required*
>
> Image file to upload as the new screen version. Supported formats: PNG, JPEG.
>
> **screen\_id** `string` *required*
>
> Unique ID of the screen to create a new version for.
>
> **project\_id** `string` *required*
>
> Unique ID of the Zeplin project containing the screen.
>
> **commit\_message** `string`
>
> Descriptive message for the screen version commit.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Screen Versions
>
> **Slug:** `ZEPLIN_SCREEN_VERSIONS_LIST`
>
> List 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
>
> **limit** `integer`
>
> Maximum number of versions to return per page (1-100)
>
> **offset** `integer`
>
> Zero-based index of the first version to return
>
> **screen\_id** `string` *required*
>
> Unique ID of the Zeplin screen to list versions for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Styleguide Color
>
> **Slug:** `ZEPLIN_STYLEGUIDE_COLOR_CREATE`
>
> Create 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
>
> **a** `number` *required*
>
> Alpha channel value (0–1)
>
> **b** `integer` *required*
>
> Blue channel value (0–255)
>
> **g** `integer` *required*
>
> Green channel value (0–255)
>
> **r** `integer` *required*
>
> Red channel value (0–255)
>
> **name** `string` *required*
>
> Name of the color
>
> **token\_type** `string`
>
> Token type for Authorization header, typically 'Bearer'
>
> **access\_token** `string`
>
> Access token value to include in Authorization header
>
> **authorization** `string`
>
> Full Authorization header value. If provided, overrides token\_type/access\_token
>
> **styleguide\_id** `string` *required*
>
> ID of the target styleguide
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Styleguide Colors
>
> **Slug:** `ZEPLIN_STYLEGUIDE_COLORS_LIST`
>
> List 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
>
> **token\_type** `string`
>
> Token type for Authorization header, typically 'Bearer'
>
> **access\_token** `string`
>
> Access token value to include in Authorization header
>
> **authorization** `string`
>
> Full Authorization header value. If provided, overrides token\_type/access\_token
>
> **styleguide\_id** `string` *required*
>
> ID of the target styleguide
>
> **linked\_project** `string`
>
> Optional project ID to grant access when requester may not be authorized to view the styleguide
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Styleguide Color
>
> **Slug:** `ZEPLIN_STYLEGUIDE_COLOR_UPDATE`
>
> Update a color in a Zeplin styleguide. An unsuccessful response can return only the requested color ID, which does not confirm the update.
>
> #### Input Parameters
>
> **a** `number`
>
> Alpha component (0.0–1.0)
>
> **b** `integer`
>
> Blue component (0–255)
>
> **g** `integer`
>
> Green component (0–255)
>
> **r** `integer`
>
> Red component (0–255)
>
> **name** `string`
>
> Name of the color
>
> **color\_id** `string` *required*
>
> ID of the color to update
>
> **source\_id** `string`
>
> Design tool/source identifier of the color
>
> **token\_type** `string`
>
> Token type to use in Authorization header, typically 'Bearer'
>
> **access\_token** `string`
>
> Access token value for Authorization header
>
> **authorization** `string`
>
> Full Authorization header value (e.g., 'Bearer x.y.z'). Overrides token\_type/access\_token if provided
>
> **styleguide\_id** `string` *required*
>
> ID of the styleguide containing the color
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Styleguide Text Styles
>
> **Slug:** `ZEPLIN_STYLEGUIDE_TEXT_STYLES_LIST`
>
> List 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
>
> **limit** `integer`
>
> Number of items to return per page (1-100)
>
> **offset** `integer`
>
> Zero-based offset for pagination
>
> **token\_type** `string`
>
> Token type for Authorization header, typically 'Bearer'
>
> **access\_token** `string`
>
> Access token value to include in Authorization header
>
> **authorization** `string`
>
> Full Authorization header value. If provided, overrides token\_type/access\_token
>
> **styleguide\_id** `string` *required*
>
> ID of the target styleguide
>
> **linked\_project** `string`
>
> Optional project ID to filter linked text styles
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Styleguide Text Style
>
> **Slug:** `ZEPLIN_STYLEGUIDE_TEXT_STYLE_UPDATE`
>
> Update 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
>
> **data** `object` *required*
>
> Fields to update on the text style
>
> **token\_type** `string`
>
> Overrides stored token type (e.g., 'Bearer')
>
> **access\_token** `string`
>
> Overrides stored access token
>
> **authorization** `string`
>
> Full Authorization header value. Overrides token\_type/access\_token if provided
>
> **styleguide\_id** `string` *required*
>
> ID of the styleguide containing the text style
>
> **text\_style\_id** `string` *required*
>
> ID of the text style to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Personal Projects
>
> **Slug:** `ZEPLIN_USERS_GET_PERSONAL_PROJECTS`
>
> List 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
>
> **limit** `integer`
>
> Number of items to return; default 30; maximum 100.
>
> **offset** `integer`
>
> Zero-based starting index; default 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
