Jump to Content
Zeplin APISupportJoin Discord!
GuidesAPI ReferenceChangelog
SupportJoin Discord!Zeplin API
API Reference

Getting Started

  • Introduction
  • Authentication
  • Rate Limiting
  • Pagination
  • Versioning
  • Accessing Linked Styleguides

Zeplin API

  • Authorization
    • Authorization endpointget
    • Access token endpointpost
  • Organizations
    • Get organizationsget
    • Get a single organizationget
    • Get organization billing detailsget
    • Get organization projectsget
    • Get organization workflow statusesget
    • Get organization styleguidesget
    • Get organization aliensget
    • Get organization membersget
    • Invite memberpost
    • Update an organization memberpatch
    • Remove an organization memberdelete
    • Get a member's projectsget
    • Get a member's styleguidesget
  • Webhooks
    • Get organization webhooksget
    • Create organization webhookspost
    • Get a webhook of organizationget
    • Delete a webhook of an organizationdelete
    • Update organization webhookspatch
    • Get project webhooksget
    • Create project webhookspost
    • Get a webhook of projectget
    • Delete a webhook of a projectdelete
    • Update project webhookspatch
    • Get styleguide webhooksget
    • Create styleguide webhookspost
    • Get a webhook of styleguideget
    • Delete a webhook of a styleguidedelete
    • Update styleguide webhookspatch
    • Get user webhooksget
    • Create user webhookspost
    • Get a webhook of userget
    • Delete a webhook of a userdelete
    • Update user webhookspatch
  • Projects
    • Get all projectsget
    • Get a single projectget
    • Update a projectpatch
    • Get project membersget
    • Invite a memberpost
    • Remove a memberdelete
  • Screens
    • Get project screensget
    • Create a new screenpost
    • Get a single screenget
    • Update a screenpatch
    • Get screen componentsget
    • Get screen notesget
    • Create a notepost
    • Get a single screen noteget
    • Update a notepatch
    • Delete a notedelete
    • Create a commentpost
    • Update commentpatch
    • Delete commentdelete
    • Get screen annotationsget
    • Create an annotationpost
    • Get a single screen annotationget
    • Update an annotationpatch
    • Delete an annotationdelete
    • Get screen annotation note typesget
    • Get screen versionsget
    • Create a new screen versionpost
    • Get a single screen versionget
    • Get the latest screen versionget
    • Get screen sectionsget
    • Get a single screen sectionget
    • Get screen variantsget
    • Get a single screen variantget
  • Colors
    • Get project colorsget
    • Create project colorpost
    • Update project colorpatch
    • Get styleguide colorsget
    • Create styleguide colorpost
    • Update styleguide colorpatch
  • TextStyles
    • Get project text stylesget
    • Update project text stylepatch
    • Get styleguide text stylesget
    • Update styleguide text stylepatch
  • Connected Components
    • Get project connected componentsget
    • Get styleguide connected componentsget
  • Components
    • Get project componentsget
    • Get a single project componentget
    • Update a project componentpatch
    • Get latest project component versionget
    • Get project component sectionsget
    • Get project pagesget
    • Get styleguide componentsget
    • Get a single styleguide componentget
    • Update a styleguide componentpatch
    • Get latest styleguide component versionget
    • Get styleguide component sectionsget
    • Get styleguide pagesget
  • Spacing
    • Get spacing tokens of the projectget
    • Update project spacing tokenpatch
    • Get spacing sections of the projectget
    • Get spacing tokens of the styleguideget
    • Update styleguide spacing tokenpatch
    • Get spacing sections of the styleguideget
  • Design Tokens
    • Get project design tokensget
    • Get styleguide design tokensget
  • Flows
    • Get project flow boardsget
    • Get a single project flow boardget
    • Get project flow board groupsget
    • Get project flow board connectorsget
    • Get a single project flow board connectorget
    • Get project flow board nodesget
    • Get a single project flow board nodeget
  • Variable Collections
    • Get project variable collectionsget
    • Get styleguide variable collectionsget
  • Styleguides
    • Get all member styleguidesget
    • Get a single styleguideget
    • Update a styleguidepatch
    • Get styleguide membersget
    • Invite a memberpost
    • Remove a memberdelete
    • Get linked projectsget
  • Users
    • Current userget
    • Get personal projectsget
    • Get personal styleguidesget
  • Notifications
    • Get user notificationsget
    • Bulk update user notificationspatch
    • Get a notification of userget
    • Update user notificationpatch

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 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
  • Notification
    • Notification Actor
    • Notification Resource
    • Notification Type
  • Object Reference
  • Organization
  • Organization Billing Details
  • Organization Member
  • Organization Summary
  • Organization Webhook
    • Organization Webhook Event Type
  • 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 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
  • Version Commit
    • Version Commit Color
  • Webhook Health
  • Webhook Status
  • Workflow Status
    • Workflow Status Color
  • Zeplin Application
Powered by 

rem Preferences

rem preferences of project or styleguide. The content of this property varies depending on the value of its status field.

Type: Enabled rem Preferences | Disabled or Linked rem Preferences