Jump to Content
Support
Join Discord!
Guides
API Reference
Changelog
Support
Join Discord!
API Reference
API Reference
Screen Note Comment
All
Pages
Start typing to search…
JUMP TO
Getting Started
Introduction
Authentication
Rate Limiting
Pagination
Versioning
Accessing Linked Styleguides
Zeplin API
Authorization
Authorization endpoint
get
Access token endpoint
post
Organizations
Get organizations
get
Get a single organization
get
Get organization billing details
get
Get organization projects
get
Get organization workflow statuses
get
Get organization styleguides
get
Get organization aliens
get
Get organization members
get
Invite member
post
Update an organization member
patch
Remove an organization member
del
Get a member's projects
get
Get a member's styleguides
get
Webhooks
Get organization webhooks
get
Create organization webhooks
post
Get a webhook of organization
get
Delete a webhook of an organization
del
Update organization webhooks
patch
Get project webhooks
get
Create project webhooks
post
Get a webhook of project
get
Delete a webhook of a project
del
Update project webhooks
patch
Get styleguide webhooks
get
Create styleguide webhooks
post
Get a webhook of styleguide
get
Delete a webhook of a styleguide
del
Update styleguide webhooks
patch
Get user webhooks
get
Create user webhooks
post
Get a webhook of user
get
Delete a webhook of a user
del
Update user webhooks
patch
Projects
Get all projects
get
Get a single project
get
Update a project
patch
Get project members
get
Invite a member
post
Remove a member
del
Screens
Get project screens
get
Create a new screen
post
Get a single screen
get
Update a screen
patch
Get screen components
get
Get screen notes
get
Create a note
post
Get a single screen note
get
Update a note
patch
Delete a note
del
Create a comment
post
Update comment
patch
Delete comment
del
Get screen annotations
get
Create an annotation
post
Get a single screen annotation
get
Update an annotation
patch
Delete an annotation
del
Get screen annotation note types
get
Get screen versions
get
Create a new screen version
post
Get a single screen version
get
Get the latest screen version
get
Get screen sections
get
Get a single screen section
get
Get screen variants
get
Get a single screen variant
get
Colors
Get project colors
get
Create project color
post
Update project color
patch
Get styleguide colors
get
Create styleguide color
post
Update styleguide color
patch
TextStyles
Get project text styles
get
Update project text style
patch
Get styleguide text styles
get
Update styleguide text style
patch
Connected Components
Get project connected components
get
Get styleguide connected components
get
Components
Get project components
get
Get a single project component
get
Update a project component
patch
Get latest project component version
get
Get project component sections
get
Get project pages
get
Get styleguide components
get
Get a single styleguide component
get
Update a styleguide component
patch
Get latest styleguide component version
get
Get styleguide component sections
get
Get styleguide pages
get
Spacing
Get spacing tokens of the project
get
Update project spacing token
patch
Get spacing sections of the project
get
Get spacing tokens of the styleguide
get
Update styleguide spacing token
patch
Get spacing sections of the styleguide
get
Design Tokens
Get project design tokens
get
Get styleguide design tokens
get
Flows
Get project flow boards
get
Get a single project flow board
get
Get project flow board groups
get
Get project flow board connectors
get
Get a single project flow board connector
get
Get project flow board nodes
get
Get a single project flow board node
get
Variable Collections
Get project variable collections
get
Get styleguide variable collections
get
Styleguides
Get all member styleguides
get
Get a single styleguide
get
Update a styleguide
patch
Get styleguide members
get
Invite a member
post
Remove a member
del
Get linked projects
get
Users
Current user
get
Get personal projects
get
Get personal styleguides
get
Notifications
Get user notifications
get
Bulk update user notifications
patch
Get a notification of user
get
Update user notification
patch
Webhook Events
Overview
Workspace Events
Workspace Notification
Workspace Project
Workspace Styleguide
Workspace Organization
Workspace Organization Member
Project Events
Project Member
Project Screen
Project Screen Version
Project Note
Project Note Comment
Project Color
Project Text Style
Project Component
Project Flow Board
Project Spacing Token
Styleguide Events
Styleguide Member
Styleguide Color
Styleguide Text Style
Styleguide Component
Styleguide Spacing Token
Models
Asset
Asset Content
Color
Color Data
Component
Component Section Reference
Component Variant Property
Component Section
Component Group
Component Section Variant
Component Section Variant Property
Component Version
Component Version Summary
Connected Component
Code
Connected Component Link
Language
Design Tokens
Color Design Token
Color Design Token Metadata
Color Design Tokens
Design Token Project
Design Token Font
Design Token Resouce
Design Token Source
Design Token Styleguide
Spacing Design Token
Spacing Design Token Metadata
Spacing Design Tokens
Text Style Design Token
Text Style Design Token Metadata
Text Style Design Token Value
Text Style Design Tokens
Error Response
Flow Board
Flow Board Connector
Flow Board Connection
Flow Board Connection Position
Flow Board Connector Label
Flow Board Group
Flow Board Node
Flow Board Position
Flow Board Node Color
Flow Board Annotation Node
Flow Board Screen Node
Flow Board Shape Node
Flow Board Text Node
Flow Board Variant Group Node
Grid
Horizontal Grid
Vertical Grid
Layer
Blend Mode
Bounding Rectangle
Color Stop
Gradient
Layer Blur
Layer Border
Layer Fill
Layer Position
Layer Shadow
Layer Text Style
Layer Text Style Range
Link
Hotspot Bounding Rectangle
Link Destination
Note Types
Notification
Notification Actor
Notification Resource
Notification Type
Object Reference
Organization
Organization Billing Details
Organization Member
Organization Summary
Organization Webhook
Organization Webhook Event Type
Page
Project
Project Status
Project Member
Project Webhook
Project Webhook Event Type
rem Preferences
Disabled or Linked rem Preferences
Enabled rem Preferences
Resource Source
Source Styleguide
Source Project
Screen
Screen Variant
Screen Variant Group Reference
Screen Annotation
Screen Annotation Color
Screen Annotation Note Type
Screen Annotation Position
Screen Note
Screen Note Color
Screen Note Color Name
Screen Note Position
Screen Note Status
Screen Note Comment
Screen Section
Screen Variant Group
Screen Variant Group Value
Screen Version
Screen Version Summary
Snapshot Image
Source
Spacing Section
Spacing Token
Spacing Token Color
Styleguide
Styleguide Status
Styleguide Member
Styleguide Webhook
Styleguide Webhook Event Type
Text Style
Text Style Data
Thumbnails
Token Response
User
User Webhook
User Webhook Event Type
Variable Collection
Variable
Variable Info
Variable Group
Variable Mode
Variable value
Version Commit
Version Commit Color
Webhook Health
Webhook Status
Workflow Status
Workflow Status Color
Zeplin Application
Powered by
Screen Note Comment
Ask AI
