Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zeplin Styleguides API

The Styleguides API from Zeplin — 6 operation(s) for styleguides.

Zeplin Styleguides API is one of 16 APIs that Zeplin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Styleguides. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.

This API exposes 8 operations across 6 paths, and defines 32 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.

8 operations 6 paths 32 schemas 1 DELETE5 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
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 Styleguides 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 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Styleguides 8
GET
/v1/styleguides
Get all member styleguides
GetStyleguides 6 params → 200404422
GET
/v1/styleguides/{styleguide_id}
Get a single styleguide
GetStyleguide 3 params → 200404
PATCH
/v1/styleguides/{styleguide_id}
Update a styleguide
UpdateStyleguide 1 param body → 204403404412422
GET
/v1/styleguides/{styleguide_id}/members
Get styleguide members
GetStyleguideMembers 5 params → 200404422
POST
/v1/styleguides/{styleguide_id}/members
Invite a member
InviteStyleguideMember 1 param body → 204402403404422423
DELETE
/v1/styleguides/{styleguide_id}/members/{member_id}
Remove a member
RemoveStyleguideMember 2 params → 204403404422423
GET
/v1/styleguides/{styleguide_id}/linked_projects
Get linked projects
GetStyleguideLinkedProjects 3 params → 200404422
GET
/v1/styleguides/{styleguide_id}/design_tokens
Get styleguide design tokens
GetStyleguideDesignTokens 3 params → 200404422

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Project (20 properties), Styleguide (17 properties), User (6 properties), WorkflowStatusColor (5 properties). Each schema is shown below with its type and property counts.

SpacingDesignToken
object
2 properties 2 required
DesignTokenProject
object
The source project of the token
4 properties 3 required
DesignTokens
object
3 properties 3 required
DesignTokenFont
object
Font information for the text style
4 properties 4 required
StyleguideStatusEnum
string
The status of the styleguide
StyleguideUpdateBody
object
3 properties
ProjectStatusEnum
string
The status of the project
ColorDesignTokens
object
Color tokens
TextStyleDesignToken
object
2 properties 2 required
WorkflowStatusColor
object
5 properties 5 required
DesignTokenStyleguide
object
The source styleguide of the token
4 properties 3 required
SpacingDesignTokens
object
Spacing tokens
EntityReference
object
1 property 1 required
ErrorResponse
object
3 properties 1 required
OrganizationSummary
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
ColorDesignTokenMetadata
object
Additional information about the color token
2 properties 2 required
ColorDesignToken
object
2 properties 2 required
StyleguideMember
object
2 properties 2 required
DesignTokenSource
object
Source details for design token. It has to be either project or styleguide.
2 properties
EnabledRemPreferences
object
4 properties 4 required
StyleguideMemberInviteBody
object
1 property 1 required
DesignTokenResource
object
Details of the resource that the design token is generated from.
2 properties 2 required
TextStyleDesignTokens
object
Text style tokens
WorkflowStatus
object
3 properties 3 required
TextStyleDesignTokenValue
object
Value of the token
5 properties 1 required
SpacingDesignTokenMetadata
object
Additional information about the spacing token
3 properties 3 required
Styleguide
object
17 properties 11 required
Project
object
20 properties 12 required
TextStyleDesignTokenMetadata
object
Additional information about the text style token
2 properties 2 required
RemPreferences
rem preferences of project or styleguide. The content of this property varies depending on the value of its status field.
DisabledOrLinkedRemPreferences
object
If status is "linked", project or styleguide uses its parent styleguide as the source of preferences.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeplin-styleguides-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 Screens API
Zeplin Spacing API
Zeplin TextStyles API