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

The Flows API from Zeplin — 7 operation(s) for flows.

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

Tagged areas include Flows. 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 7 paths, and defines 20 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 7 paths 20 schemas 7 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 Flows 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 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Flows 7
GET
/v1/projects/{project_id}/flow_boards
Get project flow boards
GetProjectFlowBoards 1 param → 200404422
GET
/v1/projects/{project_id}/flow_boards/{flow_board_id}
Get a single project flow board
GetProjectFlowBoard 2 params → 200404422
GET
/v1/projects/{project_id}/flow_boards/{flow_board_id}/groups
Get project flow board groups
GetProjectFlowBoardGroups 2 params → 200404422
GET
/v1/projects/{project_id}/flow_boards/{flow_board_id}/connectors
Get project flow board connectors
GetProjectFlowBoardConnectors 6 params → 200404422
GET
/v1/projects/{project_id}/flow_boards/{flow_board_id}/connectors/{connector_id}
Get a single project flow board connector
GetProjectFlowBoardConnector 3 params → 200404422
GET
/v1/projects/{project_id}/flow_boards/{flow_board_id}/nodes
Get project flow board nodes
GetProjectFlowBoardNodes 5 params → 200404422
GET
/v1/projects/{project_id}/flow_boards/{flow_board_id}/nodes/{node_id}
Get a single project flow board node
GetProjectFlowBoardNode 3 params → 200404422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are FlowBoardAnnotationNode (10 properties), FlowBoardShapeNode (8 properties), FlowBoardConnector (6 properties), ColorData (5 properties). Each schema is shown below with its type and property counts.

ScreenAnnotationNoteTypeEnum
string
Type of the annotation note
FlowBoardConnector
object
6 properties 4 required
FlowBoardVariantGroupNode
object
5 properties 5 required
FlowBoardNode
EntityReference
object
1 property 1 required
ColorData
object
5 properties 4 required
FlowBoardGroup
object
4 properties 4 required
ErrorResponse
object
3 properties 1 required
FlowBoardPosition
object
2 properties 2 required
FlowBoardScreenNode
object
4 properties 4 required
FlowBoard
object
5 properties 5 required
FlowBoardAnnotationNode
object
10 properties 9 required
FlowBoardConnection
object
4 properties 1 required
FlowBoardNodeColor
object
4 properties 4 required
FlowBoardTextNode
object
5 properties 5 required
FlowBoardConnectorLabel
object
3 properties 1 required
FlowBoardShapeNode
object
8 properties 8 required
FlowBoardConnectionPosition
object
2 properties 2 required
ScreenAnnotationColor
object
5 properties 4 required
ScreenAnnotationNoteType
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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