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 Design Tokens API

The Design Tokens API from Zeplin — 2 operation(s) for design tokens.

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

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

This API exposes 2 operations across 2 paths, and defines 18 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.

2 operations 2 paths 18 schemas 2 GET

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 Design Tokens 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 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Design Tokens 2
GET
/v1/projects/{project_id}/design_tokens
Get project design tokens
GetProjectDesignTokens 3 params → 200404422
GET
/v1/styleguides/{styleguide_id}/design_tokens
Get styleguide design tokens
GetStyleguideDesignTokens 3 params → 200404422

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are TextStyleDesignTokenValue (5 properties), DesignTokenStyleguide (4 properties), DesignTokenFont (4 properties), DesignTokenProject (4 properties). Each schema is shown below with its type and property counts.

ColorDesignToken
object
2 properties 2 required
SpacingDesignToken
object
2 properties 2 required
TextStyleDesignToken
object
2 properties 2 required
DesignTokenProject
object
The source project of the token
4 properties 3 required
DesignTokenStyleguide
object
The source styleguide of the token
4 properties 3 required
DesignTokens
object
3 properties 3 required
SpacingDesignTokens
object
Spacing tokens
SpacingDesignTokenMetadata
object
Additional information about the spacing token
3 properties 3 required
EntityReference
object
1 property 1 required
DesignTokenFont
object
Font information for the text style
4 properties 4 required
DesignTokenSource
object
Source details for design token. It has to be either project or styleguide.
2 properties
ErrorResponse
object
3 properties 1 required
TextStyleDesignTokenMetadata
object
Additional information about the text style token
2 properties 2 required
DesignTokenResource
object
Details of the resource that the design token is generated from.
2 properties 2 required
TextStyleDesignTokens
object
Text style tokens
ColorDesignTokenMetadata
object
Additional information about the color token
2 properties 2 required
TextStyleDesignTokenValue
object
Value of the token
5 properties 1 required
ColorDesignTokens
object
Color tokens

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeplin-design-tokens-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 Flows API
Zeplin Notifications API
Zeplin Organizations API
Zeplin Projects API
Zeplin Screens API
Zeplin Spacing API
Zeplin Styleguides API
Zeplin TextStyles API