Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zeplin Components API

The Components API from Zeplin — 10 operation(s) for components.

Zeplin Components API is one of 16 APIs that Zeplin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Components. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.

This API exposes 12 operations across 10 paths, and defines 41 schemas. It is described by OpenAPI 3.0.2, at version 1.38.0.

Requests are made against a single base URL, https://api.zeplin.dev.

12 operations 10 paths 41 schemas 10 GET2 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.38.0
Base URL
https://api.zeplin.io
Authentication
OAuth 2.0, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Zeplin Components API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (PersonalAccessToken). By default, every request must be authenticated.

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 10 GET, 2 PATCH. Each is listed below with its method, path, parameters, and response codes.

Components 12
GET
/v1/projects/{project_id}/components
Get project components
GetProjectComponents 7 params → 200404422
GET
/v1/projects/{project_id}/components/{component_id}
Get a single project component
GetProjectComponent 4 params → 200404422
PATCH
/v1/projects/{project_id}/components/{component_id}
Update a project component
UpdateProjectComponent 2 params body → 204403404422
GET
/v1/projects/{project_id}/components/{component_id}/versions/latest
Get latest project component version
GetProjectComponentLatestVersion 3 params → 200403404422
GET
/v1/projects/{project_id}/component_sections
Get project component sections
GetProjectComponentSections 4 params → 200404422
GET
/v1/projects/{project_id}/pages
Get project pages
GetProjectPages 3 params → 200404422
GET
/v1/styleguides/{styleguide_id}/components
Get styleguide components
GetStyleguideComponents 9 params → 200404422
GET
/v1/styleguides/{styleguide_id}/components/{component_id}
Get a single styleguide component
GetStyleguideComponent 6 params → 200404422
PATCH
/v1/styleguides/{styleguide_id}/components/{component_id}
Update a styleguide component
UpdateStyleguideComponent 2 params body → 204403404422
GET
/v1/styleguides/{styleguide_id}/components/{component_id}/versions/latest
Get latest styleguide component version
GetStyleguideComponentLatestVersion 5 params → 200403404422
GET
/v1/styleguides/{styleguide_id}/component_sections
Get styleguide component sections
GetStyleguideComponentSections 6 params → 200404422
GET
/v1/styleguides/{styleguide_id}/pages
Get styleguide pages
GetStyleguidePages 3 params → 200404422

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are Layer (18 properties), ComponentVersion (15 properties), TextStyleData (10 properties), Component (10 properties). Each schema is shown below with its type and property counts.

Thumbnails
object
Thumbnail image URLs in various sizes. The aspect ratio of the original image is preserved. If the width of original image is lower than the desired width then…
3 properties 3 required
ComponentUpdateBody
object
1 property 1 required
BoundingRectangle
object
5 properties 5 required
SourceEnum
string
Source application of the design
HotspotBoundingRectangle
object
4 properties 4 required
LayerFill
object
4 properties 1 required
ComponentSection
object
6 properties 4 required
LayerPosition
object
2 properties 2 required
ResourceStyleguideSource
object
The source styleguide of the resource
4 properties 3 required
Page
object
5 properties 4 required
Component
object
10 properties 4 required
VerticalGrid
object
4 properties 4 required
LayerTextStyleRange
object
2 properties
Asset
object
Assets are automatically generated while exporting designs based on the platform the design is exported. Asset formats and densities change according to these…
4 properties 2 required
ComponentGroup
object
4 properties 3 required
Gradient
object
5 properties
HorizontalGrid
object
3 properties 2 required
EntityReference
object
1 property 1 required
ColorData
object
5 properties 4 required
ErrorResponse
object
3 properties 1 required
LinkDestination
object
2 properties 2 required
ColorStop
object
2 properties 2 required
User
object
Basic info about Zeplin users. Zeplin API does not expose any personal information to third-party clients. For this reason, the email field is a Zeplin-only al…
6 properties 3 required
Link
object
2 properties 2 required
Grid
object
4 properties
AssetContent
object
3 properties 2 required
ComponentSectionReference
object
2 properties 1 required
BlendModeEnum
string
LayerBlur
object
Blur applied to the layer
2 properties
SnapshotImage
object
4 properties 4 required
ResourceSource
object
Source details for resource. It has to be either project or styleguide.
2 properties
ComponentSectionVariantProperty
object
3 properties 3 required
ComponentVersion
object
15 properties 9 required
ComponentSectionVariant
object
Variant information for this component section
2 properties 1 required
ResourceProjectSource
object
The source project of the resource
4 properties 3 required
LayerTextStyle
object
2 properties
ComponentVariantProperty
object
3 properties 3 required
TextStyleData
object
10 properties 6 required
LayerBorder
object
3 properties
Layer
object
18 properties 4 required
LayerShadow
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeplin-components-api-openapi.yml Raw ↑

Other APIs Zeplin publishes across the network.

Zeplin Authorization API
Zeplin Colors API
Zeplin Connected Components API
Zeplin Design Tokens API
Zeplin Flows API
Zeplin Notifications API
Zeplin Organizations API
Zeplin Projects API
Zeplin Screens API
Zeplin Spacing API
Zeplin Styleguides API
Zeplin TextStyles API