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

The Organizations API from Zeplin — 11 operation(s) for organizations.

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

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

This API exposes 13 operations across 11 paths, and defines 18 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.

13 operations 11 paths 18 schemas 1 DELETE10 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 Organizations 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 13

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

Organizations 13
GET
/v1/organizations
Get organizations
GetOrganizations 1 param → 200
GET
/v1/organizations/{organization_id}
Get a single organization
GetOrganization 1 param → 200404
GET
/v1/organizations/{organization_id}/billing
Get organization billing details
GetOrganizationBilling 1 param → 200403404
GET
/v1/organizations/{organization_id}/projects
Get organization projects
GetOrganizationProjects 3 params → 200404
GET
/v1/organizations/{organization_id}/workflow_statuses
Get organization workflow statuses
GetOrganizationWorkflowStatuses 1 param → 200404
GET
/v1/organizations/{organization_id}/styleguides
Get organization styleguides
GetOrganizationStyleguides 3 params → 200404
GET
/v1/organizations/{organization_id}/aliens
Get organization aliens
GetOrganizationAliens 1 param → 200403404
GET
/v1/organizations/{organization_id}/members
Get organization members
GetOrganizationMembers 4 params → 200403404
POST
/v1/organizations/{organization_id}/members
Invite member
InviteOrganizationMember 1 param body → 201400402403404422423
PATCH
/v1/organizations/{organization_id}/members/{member_id}
Update an organization member
UpdateOrganizationMember 2 params body → 204400402403404422423
DELETE
/v1/organizations/{organization_id}/members/{member_id}
Remove an organization member
RemoveOrganizationMember 2 params → 204403404422423
GET
/v1/organizations/{organization_id}/members/{member_id}/projects
Get a member's projects
GetOrganizationMemberProjects 4 params → 200403404
GET
/v1/organizations/{organization_id}/members/{member_id}/styleguides
Get a member's styleguides
GetOrganizationMemberStyleguides 4 params → 200403404

Schemas 18

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

OrganizationMemberInviteBody
object
4 properties 3 required
WorkflowStatusColor
object
5 properties 5 required
Styleguide
object
17 properties 11 required
EntityReference
object
1 property 1 required
ErrorResponse
object
3 properties 1 required
Project
object
20 properties 12 required
EnabledRemPreferences
object
4 properties 4 required
OrganizationMemberUpdateBody
object
3 properties
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
OrganizationBilling
object
2 properties 2 required
StyleguideStatusEnum
string
The status of the styleguide
WorkflowStatus
object
3 properties 3 required
OrganizationMember
object
5 properties 4 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
Organization
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeplin-organizations-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 Projects API
Zeplin Screens API
Zeplin Spacing API
Zeplin Styleguides API
Zeplin TextStyles API