Zeplin Screens API
The Screens API from Zeplin — 17 operation(s) for screens.
Zeplin Screens API is one of 16 APIs that Zeplin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Screens. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.
This API exposes 27 operations across 17 paths, and defines 66 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.
27 operations
17 paths
66 schemas
3 DELETE15 GET4 PATCH5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Zeplin Screens 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 27
Across 17 paths, the API surfaces 27 operations — 3 DELETE, 15 GET, 4 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Screens 27
GET
/v1/projects/{project_id}/screens
Get project screens
POST
/v1/projects/{project_id}/screens
Create a new screen
GET
/v1/projects/{project_id}/screens/{screen_id}
Get a single screen
PATCH
/v1/projects/{project_id}/screens/{screen_id}
Update a screen
GET
/v1/projects/{project_id}/screens/{screen_id}/components
Get screen components
GET
/v1/projects/{project_id}/screens/{screen_id}/notes
Get screen notes
POST
/v1/projects/{project_id}/screens/{screen_id}/notes
Create a note
GET
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}
Get a single screen note
PATCH
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}
Update a note
DELETE
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}
Delete a note
POST
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments
Create a comment
PATCH
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments/{comment_id}
Update comment
DELETE
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments/{comment_id}
Delete comment
GET
/v1/projects/{project_id}/screens/{screen_id}/annotations
Get screen annotations
POST
/v1/projects/{project_id}/screens/{screen_id}/annotations
Create an annotation
GET
/v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id}
Get a single screen annotation
PATCH
/v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id}
Update an annotation
DELETE
/v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id}
Delete an annotation
GET
/v1/projects/{project_id}/annotations/note_types
Get screen annotation note types
GET
/v1/projects/{project_id}/screens/{screen_id}/versions
Get screen versions
POST
/v1/projects/{project_id}/screens/{screen_id}/versions
Create a new screen version
GET
/v1/projects/{project_id}/screens/{screen_id}/versions/{version_id}
Get a single screen version
GET
/v1/projects/{project_id}/screens/{screen_id}/versions/latest
Get the latest screen version
GET
/v1/projects/{project_id}/screen_sections
Get screen sections
GET
/v1/projects/{project_id}/screen_sections/{section_id}
Get a single screen section
GET
/v1/projects/{project_id}/screen_variants
Get screen variants
GET
/v1/projects/{project_id}/screen_variants/{variant_id}
Get a single screen variant
Schemas 66
The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are Layer (18 properties), ScreenVersion (16 properties), ComponentVersion (15 properties), ScreenVersionSummary (13 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
ScreenNote
object
Screen notes are comments added to a screen and can be either point notes, which have a single point in the position field, or area notes, which have a positio…
8 properties
8 required
BoundingRectangle
object
5 properties
5 required
CommentCreateBody
object
1 property
1 required
SourceEnum
string
Source application of the design
HotspotBoundingRectangle
object
4 properties
4 required
LayerFill
object
4 properties
1 required
ScreenCreateBody
object
7 properties
2 required
ScreenAnnotation
object
8 properties
7 required
VersionCommitColor
object
4 properties
4 required
LayerPosition
object
2 properties
2 required
ScreenNoteColorNameEnum
string
ScreenVariantGroup
object
3 properties
3 required
ResourceStyleguideSource
object
The source styleguide of the resource
4 properties
3 required
ScreenSection
object
5 properties
3 required
ScreenAnnotationPosition
object
Position of the annotation with respect to top left corner. Values are normalized in [0, 1]
2 properties
2 required
Component
object
10 properties
4 required
VerticalGrid
object
4 properties
4 required
LayerTextStyleRange
object
2 properties
ScreenNoteComment
object
6 properties
5 required
ScreenVariantGroupReference
object
Variant group that contains the screen
2 properties
2 required
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
Gradient
object
5 properties
ScreenNoteUpdateBody
object
3 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
ScreenNoteCreateBody
object
3 properties
3 required
LinkDestination
object
2 properties
2 required
ColorStop
object
2 properties
2 required
ScreenNoteColor
object
5 properties
4 required
ScreenVariantGroupValue
object
2 properties
2 required
ScreenAnnotationCreateBody
object
3 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
ScreenNoteStatusEnum
string
Status of the note
Link
object
2 properties
2 required
CommentUpdateBody
object
1 property
1 required
Grid
object
4 properties
ScreenVariant
object
2 properties
2 required
ScreenNotePosition
object
Position of the note with respect to top left corner. Values are normalized in [0, 1]
4 properties
2 required
ScreenVersion
object
16 properties
9 required
AssetContent
object
3 properties
2 required
ComponentSectionReference
object
2 properties
1 required
ScreenAnnotationNoteTypeEnum
string
Type of the annotation note
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
ScreenUpdateBody
object
2 properties
ComponentVersion
object
15 properties
9 required
ScreenAnnotationColor
object
5 properties
4 required
ResourceProjectSource
object
The source project of the resource
4 properties
3 required
ScreenVersionSummary
object
13 properties
9 required
LayerTextStyle
object
2 properties
Reaction
object
4 properties
3 required
ComponentVariantProperty
object
3 properties
3 required
Screen
object
12 properties
8 required
TextStyleData
object
10 properties
6 required
LayerBorder
object
3 properties
Layer
object
18 properties
4 required
ScreenAnnotationUpdateBody
object
3 properties
VersionCommit
object
3 properties
1 required
ScreenVersionCreateBody
object
3 properties
1 required
ScreenAnnotationNoteType
object
3 properties
3 required
LayerShadow
object
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zeplin 12
Other APIs Zeplin publishes across the network.
Zeplin Authorization API
Zeplin Colors API
Zeplin Components API
Zeplin Connected Components API
Zeplin Design Tokens API
Zeplin Flows API
Zeplin Notifications API
Zeplin Organizations API
Zeplin Projects API
Zeplin Spacing API
Zeplin Styleguides API
Zeplin TextStyles API
#Screens