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

The TextStyles API from Zeplin — 4 operation(s) for textstyles.

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

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

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

4 operations 4 paths 8 schemas 2 GET2 PATCH

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 TextStyles 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 4

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

TextStyles 4
GET
/v1/projects/{project_id}/text_styles
Get project text styles
GetProjectTextStyles 4 params → 200404422
PATCH
/v1/projects/{project_id}/text_styles/{text_style_id}
Update project text style
UpdateProjectTextStyle 2 params body → 204403404422
GET
/v1/styleguides/{styleguide_id}/text_styles
Get styleguide text styles
GetStyleguideTextStyles 6 params → 200404422
PATCH
/v1/styleguides/{styleguide_id}/text_styles/{text_style_id}
Update styleguide text style
UpdateStyleguideTextStyle 2 params body → 204403404422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are TextStyle (14 properties), ColorData (5 properties), ResourceProjectSource (4 properties), ResourceStyleguideSource (4 properties). Each schema is shown below with its type and property counts.

ResourceProjectSource
object
The source project of the resource
4 properties 3 required
EntityReference
object
1 property 1 required
ColorData
object
5 properties 4 required
ErrorResponse
object
3 properties 1 required
ResourceSource
object
Source details for resource. It has to be either project or styleguide.
2 properties
TextStyleUpdateBody
object
2 properties
TextStyle
object
14 properties 9 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-textstyles-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