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 Colors API

The Colors API from Zeplin — 4 operation(s) for colors.

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

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

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

6 operations 4 paths 9 schemas 2 GET2 PATCH2 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 Colors 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 6

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

Colors 6
GET
/v1/projects/{project_id}/colors
Get project colors
GetProjectColors 4 params → 200404422
POST
/v1/projects/{project_id}/colors
Create project color
CreateProjectColor 1 param body → 200403404422
PATCH
/v1/projects/{project_id}/colors{color_id}
Update project color
UpdateProjectColor 2 params body → 204403404422
GET
/v1/styleguides/{styleguide_id}/colors
Get styleguide colors
GetStyleguideColors 6 params → 200404422
POST
/v1/styleguides/{styleguide_id}/colors
Create styleguide color
CreateStyleguideColor 1 param body → 200403404422
PATCH
/v1/styleguides/{styleguide_id}/colors/{color_id}
Update styleguide color
UpdateStyleguideColor 2 params body → 204403404422

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Color (10 properties), ColorCreateBody (6 properties), ColorUpdateBody (5 properties), ResourceProjectSource (4 properties). Each schema is shown below with its type and property counts.

ColorCreateBody
object
6 properties 5 required
ResourceProjectSource
object
The source project of the resource
4 properties 3 required
EntityReference
object
1 property 1 required
ErrorResponse
object
3 properties 1 required
ResourceSource
object
Source details for resource. It has to be either project or styleguide.
2 properties
VariableInfo
object
2 properties 2 required
Color
object
10 properties 7 required
ResourceStyleguideSource
object
The source styleguide of the resource
4 properties 3 required
ColorUpdateBody
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeplin-colors-api-openapi.yml Raw ↑

Other APIs Zeplin publishes across the network.

Zeplin Authorization 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
Zeplin TextStyles API