How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, 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.

Specification
OpenAPI 3.2.0
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 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
GetProjectScreens 5 params → 200404422
POST
/v1/projects/{project_id}/screens
Create a new screen
CreateScreen 1 param body → 200403404422
GET
/v1/projects/{project_id}/screens/{screen_id}
Get a single screen
GetScreen 2 params → 200404422
PATCH
/v1/projects/{project_id}/screens/{screen_id}
Update a screen
UpdateScreen 2 params body → 204403404422
GET
/v1/projects/{project_id}/screens/{screen_id}/components
Get screen components
GetScreenComponents 6 params → 200404422
GET
/v1/projects/{project_id}/screens/{screen_id}/notes
Get screen notes
GetScreenNotes 4 params → 200404422
POST
/v1/projects/{project_id}/screens/{screen_id}/notes
Create a note
CreateScreenNote 2 params body → 201404422
GET
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}
Get a single screen note
GetScreenNote 3 params → 200404422
PATCH
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}
Update a note
UpdateScreenNote 3 params body → 204404422
DELETE
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}
Delete a note
DeleteScreenNote 3 params → 204404422
POST
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments
Create a comment
CreateScreenComment 3 params body → 201404422
PATCH
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments/{comment_id}
Update comment
UpdateScreenComment 4 params body → 204404422
DELETE
/v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments/{comment_id}
Delete comment
DeleteScreenComment 4 params → 204404422
GET
/v1/projects/{project_id}/screens/{screen_id}/annotations
Get screen annotations
GetScreenAnnotations 4 params → 200404422
POST
/v1/projects/{project_id}/screens/{screen_id}/annotations
Create an annotation
CreateScreenAnnotation 2 params body → 201404422
GET
/v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id}
Get a single screen annotation
GetScreenAnnotation 3 params → 200404422
PATCH
/v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id}
Update an annotation
UpdateScreenAnnotation 3 params body → 204404422
DELETE
/v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id}
Delete an annotation
DeleteScreenAnnotation 3 params → 204404422
GET
/v1/projects/{project_id}/annotations/note_types
Get screen annotation note types
GetScreenAnnotationsNoteTypes 1 param → 200404422
GET
/v1/projects/{project_id}/screens/{screen_id}/versions
Get screen versions
GetScreenVersions 4 params → 200404422
POST
/v1/projects/{project_id}/screens/{screen_id}/versions
Create a new screen version
CreateScreenVersion 2 params body → 200403404422
GET
/v1/projects/{project_id}/screens/{screen_id}/versions/{version_id}
Get a single screen version
GetScreenVersion 3 params → 200403404422
GET
/v1/projects/{project_id}/screens/{screen_id}/versions/latest
Get the latest screen version
GetLatestScreenVersion 2 params → 200403404422
GET
/v1/projects/{project_id}/screen_sections
Get screen sections
GetScreenSections 3 params → 200404422
GET
/v1/projects/{project_id}/screen_sections/{section_id}
Get a single screen section
GetScreenSection 2 params → 200
GET
/v1/projects/{project_id}/screen_variants
Get screen variants
GetScreenVariants 3 params → 200404422
GET
/v1/projects/{project_id}/screen_variants/{variant_id}
Get a single screen variant
GetScreenVariant 2 params → 200404422

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.

VersionCommit
object
3 properties 1 required
ScreenSection
object
5 properties 3 required
ScreenCreateBody
object
7 properties 2 required
ComponentVersion
object
15 properties 9 required
Grid
object
4 properties
Screen
object
12 properties 8 required
Layer
object
18 properties 4 required
CommentUpdateBody
object
1 property 1 required
Reaction
object
4 properties 3 required
ScreenVariantGroupValue
object
2 properties 2 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
ScreenVariant
object
2 properties 2 required
LayerTextStyle
object
2 properties
ScreenNoteColor
object
5 properties 4 required
ColorData
object
5 properties 4 required
ComponentSectionReference
object
2 properties 1 required
ResourceSource
object
Source details for resource. It has to be either project or styleguide.
2 properties
ComponentVariantProperty
object
3 properties 3 required
ScreenAnnotationCreateBody
object
3 properties 2 required
ResourceProjectSource
object
The source project of the resource
4 properties 3 required
LayerFill
object
4 properties 1 required
SnapshotImage
object
4 properties 4 required
ScreenNoteComment
object
6 properties 5 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
Link
object
2 properties 2 required
BoundingRectangle
object
5 properties 5 required
AssetContent
object
3 properties 2 required
ScreenVersion
object
16 properties 9 required
VerticalGrid
object
4 properties 4 required
Component
object
10 properties 4 required
HorizontalGrid
object
3 properties 2 required
ScreenAnnotationColor
object
5 properties 4 required
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
ColorStop
object
2 properties 2 required
LayerBorder
object
3 properties
ScreenUpdateBody
object
2 properties
ScreenVersionCreateBody
object
3 properties 1 required
CommentCreateBody
object
1 property 1 required
ScreenAnnotationNoteType
object
3 properties 3 required
ScreenVariantGroup
object
3 properties 3 required
ScreenNoteStatusEnum
string
Status of the note
LayerPosition
object
2 properties 2 required
HotspotBoundingRectangle
object
4 properties 4 required
BlendModeEnum
string
VersionCommitColor
object
4 properties 4 required
LinkDestination
object
2 properties 2 required
LayerShadow
object
6 properties
ScreenVariantGroupReference
object
Variant group that contains the screen
2 properties 2 required
ErrorResponse
object
3 properties 1 required
ScreenNoteUpdateBody
object
3 properties
ResourceStyleguideSource
object
The source styleguide of the resource
4 properties 3 required
ScreenNotePosition
object
Position of the note with respect to top left corner. Values are normalized in [0, 1]
4 properties 2 required
ScreenVersionSummary
object
13 properties 9 required
EntityReference
object
1 property 1 required
ScreenAnnotationPosition
object
Position of the annotation with respect to top left corner. Values are normalized in [0, 1]
2 properties 2 required
TextStyleData
object
10 properties 6 required
SourceEnum
string
Source application of the design
LayerTextStyleRange
object
2 properties
ScreenNoteColorNameEnum
string
ScreenNoteCreateBody
object
3 properties 3 required
LayerBlur
object
Blur applied to the layer
2 properties
ScreenAnnotationUpdateBody
object
3 properties
ScreenAnnotation
object
8 properties 7 required
Gradient
object
5 properties
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
ScreenAnnotationNoteTypeEnum
string
Type of the annotation note

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeplin-screens-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Zeplin Screens API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.