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

The Projects API from Zeplin — 5 operation(s) for projects.

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

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

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

7 operations 5 paths 30 schemas 1 DELETE4 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 Projects 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 7

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

Projects 7
GET
/v1/projects
Get all projects
GetProjects 4 params → 200
GET
/v1/projects/{project_id}
Get a single project
GetProject 1 param → 200404
PATCH
/v1/projects/{project_id}
Update a project
UpdateProject 1 param body → 204403404409422
GET
/v1/projects/{project_id}/members
Get project members
GetProjectMembers 3 params → 200404422
POST
/v1/projects/{project_id}/members
Invite a member
InviteProjectMember 1 param body → 204402403404422423
DELETE
/v1/projects/{project_id}/members/{member_id}
Remove a member
RemoveProjectMember 2 params → 204403404422423
GET
/v1/projects/{project_id}/design_tokens
Get project design tokens
GetProjectDesignTokens 3 params → 200404422

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Project (20 properties), User (6 properties), TextStyleDesignTokenValue (5 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
ProjectMember
object
2 properties 2 required
DesignTokenFont
object
Font information for the text style
4 properties 4 required
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
ProjectUpdateBody
object
4 properties
DesignTokenSource
object
Source details for design token. It has to be either project or styleguide.
2 properties
ProjectMemberInviteBody
object
1 property 1 required
EnabledRemPreferences
object
4 properties 4 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
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-projects-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 Screens API
Zeplin Spacing API
Zeplin Styleguides API
Zeplin TextStyles API