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

The Users API from Zeplin — 3 operation(s) for users.

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

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

This API exposes 3 operations across 3 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.

3 operations 3 paths 12 schemas 3 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 Users 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 3

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

Users 3
GET
/v1/users/me
Current user
GetCurrentUser → 200
GET
/v1/users/me/projects
Get personal projects
GetUserProjects 3 params → 200
GET
/v1/users/me/styleguides
Get personal styleguides
GetUserStyleguides 3 params → 200

Schemas 12

The contract defines 12 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.

WorkflowStatusColor
object
5 properties 5 required
Styleguide
object
17 properties 11 required
EntityReference
object
1 property 1 required
Project
object
20 properties 12 required
EnabledRemPreferences
object
4 properties 4 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
StyleguideStatusEnum
string
The status of the styleguide
WorkflowStatus
object
3 properties 3 required
RemPreferences
rem preferences of project or styleguide. The content of this property varies depending on the value of its status field.
ProjectStatusEnum
string
The status of the project
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-users-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