Zeplin

Zeplin API

Access your resources in Zeplin

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Access your resources in Zeplin

Endpoints 123

Authorization

  • GETAuthorization endpoint/v1/oauth/authorize?response_type=string&client_id=string&redirect_uri=stringUsers are redirected to web app to authenticate themselves and authorize the app with client_id to act on behalf of themselves.
  • POSTAccess token endpoint/v1/oauth/tokenIf grant_type is given as authorization_code; handles code flow. If grant_type is given as refresh_token handles refresh token flow.

Organizations

  • GETGet organizations/v1/organizationsList all organizations that user is a member of
  • GETGet a single organization/v1/organizations/:organization_idGet details of the organization
  • GETGet organization billing details/v1/organizations/:organization_id/billingGet total and used seat count in the organization
  • GETGet organization projects/v1/organizations/:organization_id/projectsList all projects that belong to the organization
  • GETGet organization workflow statuses/v1/organizations/:organization_id/workflow_statusesList all workflow statuses that belong to the organization
  • GETGet organization styleguides/v1/organizations/:organization_id/styleguidesList all styleguides that belong to the organization
  • GETGet organization aliens/v1/organizations/:organization_id/aliensList all aliens in the organization
  • GETGet organization members/v1/organizations/:organization_id/membersList all members in the organization
  • POSTInvite member/v1/organizations/:organization_id/membersInvite a new organization member. ☝️*Only organization admins (or higher) can invite members using personal access tokens. OAuth applications are not allowed.*
  • DELETERemove an organization member/v1/organizations/:organization_id/members/:member_idRemove a member from organization. ☝️*Only organization admins (or higher) can remove members using personal access tokens. OAuth applications are not allowed.*
  • PATCHUpdate an organization member/v1/organizations/:organization_id/members/:member_idUpdate an organization member's role, access restriction, and tags. ☝️*Only organization admins (or higher) can update members using personal access tokens.…
  • GETGet a member's projects/v1/organizations/:organization_id/members/:member_id/projectsGet a list of projects that an organization member is a part of
  • GETGet a member's styleguides/v1/organizations/:organization_id/members/:member_id/styleguidesGet a list of styleguides that an organization member is a part of

Webhooks

  • GETGet organization webhooks/v1/organizations/:organization_id/webhooksList all webhooks of organization Note: Zeplin apps can only list the webhook that are created by them. To list all webhooks created by any app or without…
  • POSTCreate organization webhooks/v1/organizations/:organization_id/webhooksCreate a webhook for the organization Wildcard "*" can be used for project_ids and styleguide_ids to receive events for all projects and styleguides that you…
  • GETGet a webhook of organization/v1/organizations/:organization_id/webhooks/:webhook_idGet a webhook by id
  • DELETEDelete a webhook of an organization/v1/organizations/:organization_id/webhooks/:webhook_idDelete a webhook by id
  • PATCHUpdate organization webhooks/v1/organizations/:organization_id/webhooks/:webhook_idUpdate a webhook for the organization
  • GETGet project webhooks/v1/projects/:project_id/webhooksList all webhooks of the project Note: Zeplin apps can only list the webhook that are created by them. To list all webhooks created by any app or without app,…
  • POSTCreate project webhooks/v1/projects/:project_id/webhooksCreate a webhook for the project Note: Users that have authorized the app before webhooks release must re-authorize the app to create webhooks.
  • GETGet a webhook of project/v1/projects/:project_id/webhooks/:webhook_idGet a webhook by id
  • DELETEDelete a webhook of a project/v1/projects/:project_id/webhooks/:webhook_idDelete a webhook by id
  • PATCHUpdate project webhooks/v1/projects/:project_id/webhooks/:webhook_idUpdate a webhook for the project
  • GETGet styleguide webhooks/v1/styleguides/:styleguide_id/webhooksList all webhooks of the styleguide Note: Zeplin apps can only list the webhook that are created by them. To list all webhooks created by any app or without…
  • POSTCreate styleguide webhooks/v1/styleguides/:styleguide_id/webhooksCreate a webhook for the styleguide Note: Users that have authorized the app before webhooks release must re-authorize the app to create webhooks.
  • GETGet a webhook of styleguide/v1/styleguides/:styleguide_id/webhooks/:webhook_idGet a webhook by id
  • DELETEDelete a webhook of a styleguide/v1/styleguides/:styleguide_id/webhooks/:webhook_idDelete a webhook by id
  • PATCHUpdate styleguide webhooks/v1/styleguides/:styleguide_id/webhooks/:webhook_idUpdate a webhook for the styleguide
  • GETGet user webhooks/v1/users/me/webhooksList all webhooks of the user Note: Zeplin apps can only list the webhook that are created by them. To list all webhooks created by any app or without app,…
  • POSTCreate user webhooks/v1/users/me/webhooksCreate a webhook for the user Wildcard "*" can be used for project_ids and styleguide_ids to receive events for all projects and styleguides that you own.…
  • GETGet a webhook of user/v1/users/me/webhooks/:webhook_idGet a webhook by id
  • DELETEDelete a webhook of a user/v1/users/me/webhooks/:webhook_idDelete a webhook by id
  • PATCHUpdate user webhooks/v1/users/me/webhooks/:webhook_idUpdate a webhook for the user

Projects

  • GETGet all projects/v1/projectsList all projects that user is a member of
  • GETGet a single project/v1/projects/:project_idGet a project by id
  • PATCHUpdate a project/v1/projects/:project_idUpdate a project's name and description
  • GETGet project members/v1/projects/:project_id/membersList all members of the project
  • POSTInvite a member/v1/projects/:project_id/membersInvite a member to the project.
  • DELETERemove a member/v1/projects/:project_id/members/:member_idRemove a member from the project.

Screens

  • GETGet project screens/v1/projects/:project_id/screensList all screens of the project
  • POSTCreate a new screen/v1/projects/:project_id/screensCreate a new screen in the project
  • GETGet a single screen/v1/projects/:project_id/screens/:screen_idGet a single screen by id
  • PATCHUpdate a screen/v1/projects/:project_id/screens/:screen_idUpdate a screen's description
  • GETGet screen components/v1/projects/:project_id/screens/:screen_id/componentsList all components in the screen
  • GETGet screen notes/v1/projects/:project_id/screens/:screen_id/notesList all notes in the screen
  • POSTCreate a note/v1/projects/:project_id/screens/:screen_id/notesCreate a note on the screen
  • GETGet a single screen note/v1/projects/:project_id/screens/:screen_id/notes/:note_idGet a screen note by id
  • DELETEDelete a note/v1/projects/:project_id/screens/:screen_id/notes/:note_idDelete a note on the screen
  • PATCHUpdate a note/v1/projects/:project_id/screens/:screen_id/notes/:note_idUpdate a note on the screen
  • POSTCreate a comment/v1/projects/:project_id/screens/:screen_id/notes/:note_id/commentsCreate comment on the screen note
  • DELETEDelete comment/v1/projects/:project_id/screens/:screen_id/notes/:note_id/comments/:comment_idDelete a comment on the screen note
  • PATCHUpdate comment/v1/projects/:project_id/screens/:screen_id/notes/:note_id/comments/:comment_idUpdate comments on the screen note
  • GETGet screen annotations/v1/projects/:project_id/screens/:screen_id/annotationsList all annotations in the screen
  • POSTCreate an annotation/v1/projects/:project_id/screens/:screen_id/annotationsCreate an annotation on the screen
  • GETGet a single screen annotation/v1/projects/:project_id/screens/:screen_id/annotations/:annotation_idGet a screen annotation by id
  • DELETEDelete an annotation/v1/projects/:project_id/screens/:screen_id/annotations/:annotation_idDelete an annotation on the screen
  • PATCHUpdate an annotation/v1/projects/:project_id/screens/:screen_id/annotations/:annotation_idUpdate an annotation on the screen
  • GETGet screen annotation note types/v1/projects/:project_id/annotations/note_typesList all annotation note types in the project
  • GETGet screen versions/v1/projects/:project_id/screens/:screen_id/versionsList all versions of the screen in a project
  • POSTCreate a new screen version/v1/projects/:project_id/screens/:screen_id/versionsCreate a new screen version in the project
  • GETGet a single screen version/v1/projects/:project_id/screens/:screen_id/versions/:version_idGet details of the screen version
  • GETGet the latest screen version/v1/projects/:project_id/screens/:screen_id/versions/latestGet details of the latest version
  • GETGet screen sections/v1/projects/:project_id/screen_sectionsList all screen sections of the project
  • GETGet a single screen section/v1/projects/:project_id/screen_sections/:section_idGet a screen section by id
  • GETGet screen variants/v1/projects/:project_id/screen_variantsList all screen variants of the project
  • GETGet a single screen variant/v1/projects/:project_id/screen_variants/:variant_idGet a screen variant by id

Colors

  • GETGet project colors/v1/projects/:project_id/colorsThis endpoint returns all of the colors in a project. You need to be a member of the project or a member of the organization that owns the project. Returns…
  • POSTCreate project color/v1/projects/:project_id/colorsCreate a color in the project's local styleguide
  • PATCHUpdate project color/v1/projects/:project_id/colors:color_idUpdate a color in the project's local styleguide
  • GETGet styleguide colors/v1/styleguides/:styleguide_id/colorsReturns colors in a styleguide that user has access. See Styleguide docs for more details about how linked_project and linked_styleguide parameters can be…
  • POSTCreate styleguide color/v1/styleguides/:styleguide_id/colorsCreate a color in the styleguide's local styleguide
  • PATCHUpdate styleguide color/v1/styleguides/:styleguide_id/colors/:color_idUpdate a color in the styleguide

TextStyles

  • GETGet project text styles/v1/projects/:project_id/text_stylesList all text styles in the project's local styleguide
  • PATCHUpdate project text style/v1/projects/:project_id/text_styles/:text_style_idUpdate a text style in the project's local styleguide
  • GETGet styleguide text styles/v1/styleguides/:styleguide_id/text_stylesReturns the text styles of the styleguide that user has access. See Styleguide docs for more details about how linked_project and linked_styleguide parameters…
  • PATCHUpdate styleguide text style/v1/styleguides/:styleguide_id/text_styles/:text_style_idUpdate a text style in the styleguide

Connected Components

  • GETGet project connected components/v1/projects/:project_id/connected_componentsList all connected components of a project
  • GETGet styleguide connected components/v1/styleguides/:styleguide_id/connected_componentsList all connected components of a project

Components

  • GETGet project components/v1/projects/:project_id/componentsList all components of a project
  • GETGet a single project component/v1/projects/:project_id/components/:component_idGet a project component by id
  • PATCHUpdate a project component/v1/projects/:project_id/components/:component_idUpdate a component's description in a project
  • GETGet latest project component version/v1/projects/:project_id/components/:component_id/versions/latestGet latest version of the component in a project
  • GETGet project component sections/v1/projects/:project_id/component_sectionsList all component sections of the project
  • GETGet project pages/v1/projects/:project_id/pagesList all pages of the project
  • GETGet styleguide components/v1/styleguides/:styleguide_id/componentsReturns components in a styleguide that user has access. See Styleguide docs for more details about how linked_project and linked_styleguide parameters can be…
  • GETGet a single styleguide component/v1/styleguides/:styleguide_id/components/:component_idReturns the component in a styleguide that user has access. See Styleguide docs for more details about how linked_project and linked_styleguide parameters can…
  • PATCHUpdate a styleguide component/v1/styleguides/:styleguide_id/components/:component_idUpdate a component's description in a styleguide
  • GETGet latest styleguide component version/v1/styleguides/:styleguide_id/components/:component_id/versions/latestReturns the latest version of the component in a styleguide that user has access. See Styleguide docs for more details about how linked_project and…
  • GETGet styleguide component sections/v1/styleguides/:styleguide_id/component_sectionsReturns the component sections of a styleguide that user has access. See Styleguide docs for more details about how linked_project and linked_styleguide…
  • GETGet styleguide pages/v1/styleguides/:styleguide_id/pagesList all pages of the styleguide

Spacing

  • GETGet spacing tokens of the project/v1/projects/:project_id/spacing_tokensList all spacing tokens of the project
  • PATCHUpdate project spacing token/v1/projects/:project_id/spacing_tokens/:spacing_token_idUpdate a spacing token in the project's local styleguide
  • GETGet spacing sections of the project/v1/projects/:project_id/spacing_sectionsList all spacing sections of the project
  • GETGet spacing tokens of the styleguide/v1/styleguides/:styleguide_id/spacing_tokensList all spacing tokens of the styleguide that user has access. See Styleguide docs for more details about how linked_project and linked_styleguide parameters…
  • PATCHUpdate styleguide spacing token/v1/styleguides/:styleguide_id/spacing_tokens/:spacing_token_idUpdate a spacing token in the styleguide
  • GETGet spacing sections of the styleguide/v1/styleguides/:styleguide_id/spacing_sectionsList all spacing sections of the styleguide that user has access. See Styleguide docs for more details about how linked_project and linked_styleguide…

Design Tokens

  • GETGet project design tokens/v1/projects/:project_id/design_tokensFetch all design tokens of the project
  • GETGet styleguide design tokens/v1/styleguides/:styleguide_id/design_tokensFetch all design tokens of the styleguide

Flows

  • GETGet project flow boards/v1/projects/:project_id/flow_boardsList all flow boards in a project.
  • GETGet a single project flow board/v1/projects/:project_id/flow_boards/:flow_board_idGet flow board details related to a project
  • GETGet project flow board groups/v1/projects/:project_id/flow_boards/:flow_board_id/groupsList all flow board groups in a project.
  • GETGet project flow board connectors/v1/projects/:project_id/flow_boards/:flow_board_id/connectorsList all connectors of the flow board in a project
  • GETGet a single project flow board connector/v1/projects/:project_id/flow_boards/:flow_board_id/connectors/:connector_idGet details of the project flow board connector
  • GETGet project flow board nodes/v1/projects/:project_id/flow_boards/:flow_board_id/nodesList all nodes of the flow board in a project
  • GETGet a single project flow board node/v1/projects/:project_id/flow_boards/:flow_board_id/nodes/:node_idGet details of the project flow board node

Variable Collections

  • GETGet project variable collections/v1/projects/:project_id/variable_collectionsThis endpoint returns all of the color variables in a project You need to be a member of the project or a member of the organization that owns the project.…
  • GETGet styleguide variable collections/v1/styleguides/:styleguide_id/variable_collectionsThis endpoint returns all of the color variables in a styleguide You need to be a member of the styleguide or a member of the organization that owns the…

Styleguides

  • GETGet all member styleguides/v1/styleguidesLists all styleguides user is a member of unless linked_project or linked_styleguide parameter is given. If linked_project parameter is provided, lists…
  • GETGet a single styleguide/v1/styleguides/:styleguide_idReturns a single styleguide that user has access. User is considered eligible to access a styleguide if any of the following conditions is met: * User is a…
  • PATCHUpdate a styleguide/v1/styleguides/:styleguide_idUpdate a styleguide's name and description
  • GETGet styleguide members/v1/styleguides/:styleguide_id/membersReturns members of a styleguide that user has access. See Styleguide docs for more details about how linked_project and linked_styleguide parameters can be…
  • POSTInvite a member/v1/styleguides/:styleguide_id/membersInvite a member to the styleguide.
  • DELETERemove a member/v1/styleguides/:styleguide_id/members/:member_idRemove a member from the styleguide.
  • GETGet linked projects/v1/styleguides/:styleguide_id/linked_projectsList all projects linked to the styleguide

Users

  • GETCurrent user/v1/users/meGet current user's details
  • GETGet personal projects/v1/users/me/projectsList all projects that belong to the current user
  • GETGet personal styleguides/v1/users/me/styleguidesList all styleguides that belong to the current user

Notifications

  • GETGet user notifications/v1/users/me/notificationsList all notifications of the user
  • PATCHBulk update user notifications/v1/users/me/notificationsUpdates all user notifications unless type or id parameter is given. If type parameter is provided, updates notifications with matching type. Similarly,…
  • GETGet a notification of user/v1/users/me/notifications/:notification_idGet a notification by id
  • PATCHUpdate user notification/v1/users/me/notifications/:notification_idUpdate a notification for the user

API details

Base URL
https://api.zeplin.dev
Authentication
OAuth 2.0 (authorization code flow)
A bearer token in the Authorization header
Operations
123 operations on 89 pathsGET 77PATCH 21POST 15DELETE 10
Main resources
Screens 27Webhooks 20Organizations 13Components 12Styleguides 8Flows 7Projects 7Colors 6Spacing 6Notifications 4
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 1.43.0

How to test the Zeplin API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Zeplin API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Authorization endpoint” (GET /v1/oauth/authorize?response_type=string&client_id=string&redirect_uri=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Zeplin API?

Access your resources in Zeplin It is listed under Developer tools and has 123 endpoints.

Who publishes the Zeplin API?

It is listed from Zeplin's public API description (an OpenAPI document), not published by Zeplin on Swastik Codes. Anyone who controls zeplin.io can claim the profile by adding a DNS TXT record.

What is the base URL of the Zeplin API?

Requests go to https://api.zeplin.dev. Endpoint paths are added to this base URL.

How do I authenticate with the Zeplin API?

It accepts 2 methods: OAuth 2.0 (authorization code flow); A bearer token in the Authorization header.

How many endpoints does the Zeplin API have?

123 operations on 89 paths (77 GET, 21 PATCH, 15 POST, 10 DELETE). The largest groups are Screens, Webhooks, Organizations, Components.

Is forking the Zeplin API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.