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 Variable Collections API

The Variable Collections API from Zeplin — 2 operation(s) for variable collections.

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

Tagged areas include Variable Collections. 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 12 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 12 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 Variable Collections 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.

Variable Collections 2
GET
/v1/projects/{project_id}/variable_collections
Get project variable collections
GetProjectVariableCollections 4 params → 200404422
GET
/v1/styleguides/{styleguide_id}/variable_collections
Get styleguide variable collections
GetStyleguideVariableCollections 4 params → 200404422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are VariableCollection (8 properties), ColorData (5 properties), VariableGroup (5 properties), Variable (5 properties). Each schema is shown below with its type and property counts.

VariableValueTypeEnum
string
Variable value types
ResourceProjectSource
object
The source project of the resource
4 properties 3 required
Variable
object
5 properties 4 required
EntityReference
object
1 property 1 required
ColorData
object
5 properties 4 required
VariableCollection
object
8 properties 6 required
ErrorResponse
object
3 properties 1 required
VariableGroup
object
5 properties 3 required
ResourceSource
object
Source details for resource. It has to be either project or styleguide.
2 properties
VariableMode
object
3 properties 3 required
VariableValue
object
3 properties 3 required
ResourceStyleguideSource
object
The source styleguide of the resource
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeplin-variable-collections-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 Styleguides API