Zeplin

Zeplin Screens API

The Screens API from Zeplin — 17 operation(s) for screens.

GitHub OpenAPI

Operations 27

GET /v1/projects/{project_id}/screens Get project screens #
POST /v1/projects/{project_id}/screens Create a new screen #
GET /v1/projects/{project_id}/screens/{screen_id} Get a single screen #
PATCH /v1/projects/{project_id}/screens/{screen_id} Update a screen #
GET /v1/projects/{project_id}/screens/{screen_id}/components Get screen components #
GET /v1/projects/{project_id}/screens/{screen_id}/notes Get screen notes #
POST /v1/projects/{project_id}/screens/{screen_id}/notes Create a note #
GET /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id} Get a single screen note #
PATCH /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id} Update a note #
DELETE /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id} Delete a note #
POST /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments Create a comment #
PATCH /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments/{comment_id} Update comment #
DELETE /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments/{comment_id} Delete comment #
GET /v1/projects/{project_id}/screens/{screen_id}/annotations Get screen annotations #
POST /v1/projects/{project_id}/screens/{screen_id}/annotations Create an annotation #
GET /v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id} Get a single screen annotation #
PATCH /v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id} Update an annotation #
DELETE /v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id} Delete an annotation #
GET /v1/projects/{project_id}/annotations/note_types Get screen annotation note types #
GET /v1/projects/{project_id}/screens/{screen_id}/versions Get screen versions #
POST /v1/projects/{project_id}/screens/{screen_id}/versions Create a new screen version #
GET /v1/projects/{project_id}/screens/{screen_id}/versions/{version_id} Get a single screen version #
GET /v1/projects/{project_id}/screens/{screen_id}/versions/latest Get the latest screen version #
GET /v1/projects/{project_id}/screen_sections Get screen sections #
GET /v1/projects/{project_id}/screen_sections/{section_id} Get a single screen section #
GET /v1/projects/{project_id}/screen_variants Get screen variants #
GET /v1/projects/{project_id}/screen_variants/{variant_id} Get a single screen variant #

Documentation

📖
Documentation
https://docs.zeplin.dev/docs/welcome
📖
Authentication
https://docs.zeplin.dev/reference/authentication
📖
RateLimits
https://docs.zeplin.dev/reference/rate-limiting

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zeplin/refs/heads/main/openapi/zeplin-screens-api-openapi.yml

Other Resources

🔗
Webhooks
https://docs.zeplin.dev/reference/webhook-events-overview
🔗
JavaScriptSDK
https://github.com/zeplin/javascript-sdk
🔗
CLI
https://github.com/zeplin/cli
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/zeplin/refs/heads/main/graphql/zeplin-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zeplin-screens-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zeplin-screens-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zeplin Authorization Screens API
  description: Access your resources in Zeplin
  version: 1.38.0
  contact:
    name: Zeplin
    url: https://zeplin.io
    email: support@zeplin.io
servers:
- url: https://api.zeplin.dev
security:
- PersonalAccessToken: []
- OAuth2: []
tags:
- name: Screens
paths:
  /v1/projects/{project_id}/screens:
    get:
      tags:
      - Screens
      summary: Get project screens
      description: List all screens of the project
      operationId: GetProjectScreens
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/filter_by_section_id'
      - $ref: '#/components/parameters/sort_screens'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Screen'
              examples:
                Screens:
                  value:
                  - $ref: '#/components/examples/screen/value'
        '404':
          $ref: '#/components/responses/projectNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    post:
      tags:
      - Screens
      summary: Create a new screen
      description: Create a new screen in the project
      operationId: CreateScreen
      parameters:
      - $ref: '#/components/parameters/project_id'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ScreenCreateBody'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReference'
              examples:
                response:
                  $ref: '#/components/examples/entityReference'
        '403':
          $ref: '#/components/responses/cannotCreateAScreen'
        '404':
          $ref: '#/components/responses/projectOrScreenSectionNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchivedOrScreenExists'
  /v1/projects/{project_id}/screens/{screen_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen
      description: Get a single screen by id
      operationId: GetScreen
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Screen'
              examples:
                response:
                  $ref: '#/components/examples/screen'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    patch:
      tags:
      - Screens
      summary: Update a screen
      description: Update a screen's description
      operationId: UpdateScreen
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenUpdateBody'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '403':
          $ref: '#/components/responses/cannotUpdateScreen'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchivedOrTagIsLocked'
  /v1/projects/{project_id}/screens/{screen_id}/components:
    get:
      tags:
      - Screens
      summary: Get screen components
      description: List all components in the screen
      operationId: GetScreenComponents
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/include_latest_version'
      - $ref: '#/components/parameters/include_linked_styleguides'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Component'
              examples:
                response:
                  value:
                  - $ref: '#/components/examples/component/value'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screens/{screen_id}/notes:
    get:
      tags:
      - Screens
      summary: Get screen notes
      description: List all notes in the screen
      operationId: GetScreenNotes
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenNote'
              examples:
                Screen Notes:
                  value:
                  - $ref: '#/components/examples/screenNote/value'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    post:
      tags:
      - Screens
      summary: Create a note
      description: Create a note on the screen
      operationId: CreateScreenNote
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenNoteCreateBody'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReference'
              examples:
                response:
                  $ref: '#/components/examples/entityReference'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
  /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen note
      description: Get a screen note by id
      operationId: GetScreenNote
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenNote'
              examples:
                response:
                  $ref: '#/components/examples/screenNote'
        '404':
          $ref: '#/components/responses/projectScreenOrNoteNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    patch:
      tags:
      - Screens
      summary: Update a note
      description: Update a note on the screen
      operationId: UpdateScreenNote
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenNoteUpdateBody'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenOrNoteNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
    delete:
      tags:
      - Screens
      summary: Delete a note
      description: Delete a note on the screen
      operationId: DeleteScreenNote
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenOrNoteNotFound'
        '422':
          $ref: '#/components/responses/notNoteCreatorOrProjectArchived'
  /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments:
    post:
      tags:
      - Screens
      summary: Create a comment
      description: Create comment on the screen note
      operationId: CreateScreenComment
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentCreateBody'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReference'
              examples:
                response:
                  $ref: '#/components/examples/entityReference'
        '404':
          $ref: '#/components/responses/projectScreenOrNoteNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
  /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments/{comment_id}:
    patch:
      tags:
      - Screens
      summary: Update comment
      description: Update comments on the screen note
      operationId: UpdateScreenComment
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      - $ref: '#/components/parameters/screen_comment_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentUpdateBody'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenNoteOrCommentNotFound'
        '422':
          $ref: '#/components/responses/unproccessableEntityUpdateComment'
    delete:
      tags:
      - Screens
      summary: Delete comment
      description: Delete a comment on the screen note
      operationId: DeleteScreenComment
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      - $ref: '#/components/parameters/screen_comment_id'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenNoteOrCommentNotFound'
        '422':
          $ref: '#/components/responses/notCommentAuthorOrProjectArchived'
  /v1/projects/{project_id}/screens/{screen_id}/annotations:
    get:
      tags:
      - Screens
      summary: Get screen annotations
      description: List all annotations in the screen
      operationId: GetScreenAnnotations
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenAnnotation'
              examples:
                Screen Annotations:
                  value:
                  - $ref: '#/components/examples/screenAnnotation/value'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    post:
      tags:
      - Screens
      summary: Create an annotation
      description: Create an annotation on the screen
      operationId: CreateScreenAnnotation
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenAnnotationCreateBody'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReference'
              examples:
                response:
                  $ref: '#/components/examples/entityReference'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
  /v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen annotation
      description: Get a screen annotation by id
      operationId: GetScreenAnnotation
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_annotation_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenAnnotation'
              examples:
                response:
                  $ref: '#/components/examples/screenAnnotation'
        '404':
          $ref: '#/components/responses/projectScreenOrAnnotationNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    patch:
      tags:
      - Screens
      summary: Update an annotation
      description: Update an annotation on the screen
      operationId: UpdateScreenAnnotation
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_annotation_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenAnnotationUpdateBody'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenOrAnnotationNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
    delete:
      tags:
      - Screens
      summary: Delete an annotation
      description: Delete an annotation on the screen
      operationId: DeleteScreenAnnotation
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_annotation_id'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenOrAnnotationNotFound'
        '422':
          $ref: '#/components/responses/notAnnotationCreatorOrProjectArchived'
  /v1/projects/{project_id}/annotations/note_types:
    get:
      tags:
      - Screens
      summary: Get screen annotation note types
      description: List all annotation note types in the project
      operationId: GetScreenAnnotationsNoteTypes
      parameters:
      - $ref: '#/components/parameters/project_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenAnnotationNoteType'
              examples:
                Screen Annotation Note Types:
                  value:
                  - $ref: '#/components/examples/screenAnnotationNoteType/value'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screens/{screen_id}/versions:
    get:
      tags:
      - Screens
      summary: Get screen versions
      description: List all versions of the screen in a project
      operationId: GetScreenVersions
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenVersionSummary'
              examples:
                Screen Versions:
                  value:
                  - $ref: '#/components/examples/screenVersionSummary/value'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    post:
      tags:
      - Screens
      summary: Create a new screen version
      description: Create a new screen version in the project
      operationId: CreateScreenVersion
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ScreenVersionCreateBody'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReference'
              examples:
                response:
                  $ref: '#/components/examples/entityReference'
        '403':
          $ref: '#/components/responses/cannotCreateAScreenVersion'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
  /v1/projects/{project_id}/screens/{screen_id}/versions/{version_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen version
      description: Get details of the screen version
      operationId: GetScreenVersion
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_version_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenVersion'
              examples:
                response:
                  $ref: '#/components/examples/screenVersion'
        '403':
          $ref: '#/components/responses/cannotGetVersionInProject'
        '404':
          $ref: '#/components/responses/projectScreenOrVersionNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screens/{screen_id}/versions/latest:
    get:
      tags:
      - Screens
      summary: Get the latest screen version
      description: Get details of the latest version
      operationId: GetLatestScreenVersion
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenVersion'
              examples:
                response:
                  $ref: '#/components/examples/screenVersion'
        '403':
          $ref: '#/components/responses/cannotGetVersionInProject'
        '404':
          $ref: '#/components/responses/projectScreenOrVersionNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screen_sections:
    get:
      tags:
      - Screens
      summary: Get screen sections
      description: List all screen sections of the project
      operationId: GetScreenSections
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenSection'
              examples:
                Screen Sections:
                  value:
                  - $ref: '#/components/examples/screenSection/value'
        '404':
          $ref: '#/components/responses/projectNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screen_sections/{section_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen section
      description: Get a screen section by id
      operationId: GetScreenSection
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_section_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenSection'
              examples:
                response:
                  $ref: '#/components/examples/screenSection'
  /v1/projects/{project_id}/screen_variants:
    get:
      tags:
      - Screens
      summary: Get screen variants
      description: List all screen variants of the project
      operationId: GetScreenVariants
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenVariantGroup'
              examples:
                Screen Variants:
                  value:
                  - $ref: '#/components/examples/screenVariantGroup/value'
        '404':
          $ref: '#/components/responses/projectNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screen_variants/{variant_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen variant
      description: Get a screen variant by id
      operationId: GetScreenVariant
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_variant_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenVariantGroup'
              examples:
                response:
                  $ref: '#/components/examples/screenVariantGroup'
        '404':
          $ref: '#/components/responses/projectOrScreenVariantNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
components:
  responses:
    projectScreenOrVersionNotFound:
      description: Project, screen or version not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Project not found:
              value:
                message: Project not found
            Screen not found:
              value:
                message: Screen not found
            Version not found:
              value:
                message: Version not found
    projectOrScreenSectionNotFound:
      description: Project or screen section not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Project not found:
              value:
                message: Project not found
            Screen section not found:
              value:
                message: Screen section not found
    notAnnotationCreatorOrProjectArchived:
      description: Not the creator of the annotation or project archived
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Not the creator of the annotation:
              value:
                message: User is not the creator of the annotation
            Project is archived:
              value:
                message: Project is archived
    unproccessableEntityUpdateComment:
      description: Not a project member, project archived or comment author is not the same errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Not a project member:
              value:
                message: User is not a member of the project
            Project archived:
              value:
                message: Project is archived
            Comment author is not the same:
              value:
                message: User is not the author of the comment
    notAProjectMemberOrArchivedOrScreenExists:
      description: Not a project member or project archived or screen with name already exists
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Not a member:
              value:
                message: User is not a member of the project
            Project is archived:
              value:
                message: Project is archived
            Screen with name already exists:
              value:
                message: Screen with name "My Screen" already exists in the project. You can create a new version for this screen instead.
    projectScreenOrNoteNotFound:
      description: Project, screen or note not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Project not found:
              value:
                message: Project not found
            Screen not found:
              value:
                message: Screen not found
            Note not found:
              value:
                message: Note not found
    cannotCreateAScreen:
      description: User cannot create a screen
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            User cannot create a screen:
              value:
                message: Only editors (or higher) can create a screen in a project
    cannotUpdateScreen:
      description: User cannot update the screen
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            User cannot update the screen:
              value:
                message: User with role alien in a project cannot update the screen
    projectOrScreenNotFound:
      description: Project or screen not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Project not found:
              value:
                message: Project not found
            Screen not found:
              value:
                message: Screen not found
    notNoteCreatorOrProjectArchived:
      description: Not the creator of the note or project archived
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Not the creator of the note:
              value:
                message: User is not the creator of the note
            Project is archived:
              value:
                message: Project is archived
    projectNotFound:
      description: Project not found response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Project not found response:
              value:
                message: Project not found
    cannotGetVersionInProject:
      description: Cannot get version in project
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Cannot get version in project:
              value:
                message: User with role alien in a project cannot get version
    notAProjectMemberOrArchived:
      description: Not a project member or project archived
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Not a member:
              value:
                message: User is not a member of the project
            Project is archived:
              value:
                message: Project is archived
    projectScreenOrAnnotationNotFound:
      description: Project, screen or annotation not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Project not found:
              value:
                message: Project not found
            Screen not found:
              value:
                message: Screen not found
            Annotation not found:
              value:
                message: Annotation not found
    projectOrScreenVariantNotFound:
      description: Project or screen variant not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Project not found:
              value:
                message: Project not found
            Screen variant not found:
              value:
                message: Screen variant not found
    notCommentAuthorOrProjectArchived:
      description: Not the author of the comment or project archived
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Not the author of the comment:
              value:
                message: User is not the author of the comment
            Project is archived:
              value:
                message: Project is archived
    projectArchived:
      description: Project archived response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Project archived response:
              value:
                message: Project is archived
    noContent:
      description: Successful response
    cannotCreateAScreenVersion:
      description: User cannot create a screen version
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            User cannot create a screen version:
              value:
                message: Only editors (or higher) can create a screen version in a project
    projectScreenNoteOrCommentNotFound:
      description: Project, screen, note or comment not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            Project not found:
              value:
                message: Project not found
            Screen not found:
              value:
                message: Screen not found
            Note not found:
              value:
                me

# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zeplin/refs/heads/main/openapi/zeplin-screens-api-openapi.yml