# Zeplin API Documentation

> Zeplin API and Webhooks provide you all the things you need to build a custom integration using the data in Zeplin. It lets you read all the resources including projects, screens, components, layers, assets, notes and so on.

## Guides: Documentation
- [Documentation](https://docs.zeplin.dev/docs.md): Zeplin API documentation

## API Reference: Zeplin API
- [Authorization endpoint](https://docs.zeplin.dev/reference/oauthauthorize.md): Users are redirected to web app to authenticate themselves and authorize the app with `client_id` to act on behalf of themselves.
- [Access token endpoint](https://docs.zeplin.dev/reference/oauthposttoken.md): If `grant_type` is given as `authorization_code`; handles code flow. If `grant_type` is given as `refresh_token` handles refresh token flow.
- [Get organizations](https://docs.zeplin.dev/reference/getorganizations.md): List all organizations that user is a member of
- [Get a single organization](https://docs.zeplin.dev/reference/getorganization.md): Get details of the organization
- [Get organization billing details](https://docs.zeplin.dev/reference/getorganizationbilling.md): Get total and used seat count in the organization
- [Get organization projects](https://docs.zeplin.dev/reference/getorganizationprojects.md): List all projects that belong to the organization
- [Get organization workflow statuses](https://docs.zeplin.dev/reference/getorganizationworkflowstatuses.md): List all workflow statuses that belong to the organization
- [Get organization styleguides](https://docs.zeplin.dev/reference/getorganizationstyleguides.md): List all styleguides that belong to the organization
- [Get organization aliens](https://docs.zeplin.dev/reference/getorganizationaliens.md): List all aliens in the organization
- [Get organization members](https://docs.zeplin.dev/reference/getorganizationmembers.md): List all members in the organization
- [Invite member](https://docs.zeplin.dev/reference/inviteorganizationmember.md): Invite a new organization member.  ☝️*Only organization admins (or higher) can invite members using **personal access tokens**. OAuth applications are not allowed.*
- [Update an organization member](https://docs.zeplin.dev/reference/updateorganizationmember.md): Update an organization member's role, access restriction, and tags.  ☝️*Only organization admins (or higher) can update members using **personal access tokens**. OAuth applications are not allowed.*
- [Remove an organization member](https://docs.zeplin.dev/reference/removeorganizationmember.md): Remove a member from organization.  ☝️*Only organization admins (or higher) can remove members using **personal access tokens**. OAuth applications are not allowed.*
- [Get a member's projects](https://docs.zeplin.dev/reference/getorganizationmemberprojects.md): Get a list of projects that an organization member is a part of
- [Get a member's styleguides](https://docs.zeplin.dev/reference/getorganizationmemberstyleguides.md): Get a list of styleguides that an organization member is a part of
- [Get organization webhooks](https://docs.zeplin.dev/reference/getorganizationwebhooks.md): List all webhooks of organization  Note: Zeplin apps can only list the webhook that are created by them. To list all webhooks created by any app or without app, personal access token is needed.
- [Create organization webhooks](https://docs.zeplin.dev/reference/createorganizationwebhooks.md): Create a webhook for the organization  Wildcard `"*"` can be used for `project_ids` and `styleguide_ids` to receive events for all projects and styleguides that you own. You'll also automatically…
- [Get a webhook of organization](https://docs.zeplin.dev/reference/getorganizationwebhook.md): Get a webhook by id
- [Delete a webhook of an organization](https://docs.zeplin.dev/reference/deleteorganizationwebhook.md): Delete a webhook by id
- [Update organization webhooks](https://docs.zeplin.dev/reference/updateorganizationwebhooks.md): Update a webhook for the organization
- [Get project webhooks](https://docs.zeplin.dev/reference/getprojectwebhooks.md): List all webhooks of the project  Note: Zeplin apps can only list the webhook that are created by them. To list all webhooks created by any app or without app, personal access token is needed.
- [Create project webhooks](https://docs.zeplin.dev/reference/createprojectwebhooks.md): Create a webhook for the project  Note: Users that have authorized the app before webhooks release must re-authorize the app to create webhooks.
- [Get a webhook of project](https://docs.zeplin.dev/reference/getprojectwebhook.md): Get a webhook by id
- [Delete a webhook of a project](https://docs.zeplin.dev/reference/deleteprojectwebhook.md): Delete a webhook by id
- [Update project webhooks](https://docs.zeplin.dev/reference/updateprojectwebhooks.md): Update a webhook for the project
- [Get styleguide webhooks](https://docs.zeplin.dev/reference/getstyleguidewebhooks.md): List all webhooks of the styleguide  Note: Zeplin apps can only list the webhook that are created by them. To list all webhooks created by any app or without app, personal access token is needed.
- [Create styleguide webhooks](https://docs.zeplin.dev/reference/createstyleguidewebhooks.md): Create a webhook for the styleguide  Note: Users that have authorized the app before webhooks release must re-authorize the app to create webhooks.
- [Get a webhook of styleguide](https://docs.zeplin.dev/reference/getstyleguidewebhook.md): Get a webhook by id
- [Delete a webhook of a styleguide](https://docs.zeplin.dev/reference/deletestyleguidewebhook.md): Delete a webhook by id
- [Update styleguide webhooks](https://docs.zeplin.dev/reference/updatestyleguidewebhooks.md): Update a webhook for the styleguide
- [Get user webhooks](https://docs.zeplin.dev/reference/getuserwebhooks.md): List all webhooks of the user  Note: Zeplin apps can only list the webhook that are created by them. To list all webhooks created by any app or without app, personal access token is needed.
- [Create user webhooks](https://docs.zeplin.dev/reference/createuserwebhooks.md): Create a webhook for the user  Wildcard `"*"` can be used for `project_ids` and `styleguide_ids` to receive events for all projects and styleguides that you own. You'll also automatically subscribe…
- [Get a webhook of user](https://docs.zeplin.dev/reference/getuserwebhook.md): Get a webhook by id
- [Delete a webhook of a user](https://docs.zeplin.dev/reference/deleteuserwebhook.md): Delete a webhook by id
- [Update user webhooks](https://docs.zeplin.dev/reference/updateuserwebhooks.md): Update a webhook for the user
- [Get all projects](https://docs.zeplin.dev/reference/getprojects.md): List all projects that user is a member of
- [Get a single project](https://docs.zeplin.dev/reference/getproject.md): Get a project by id
- [Update a project](https://docs.zeplin.dev/reference/updateproject.md): Update a project's name and description
- [Get project members](https://docs.zeplin.dev/reference/getprojectmembers.md): List all members of the project
- [Invite a member](https://docs.zeplin.dev/reference/inviteprojectmember.md): Invite a member to the project.
- [Remove a member](https://docs.zeplin.dev/reference/removeprojectmember.md): Remove a member from the project.
- [Get project screens](https://docs.zeplin.dev/reference/getprojectscreens.md): List all screens of the project
- [Create a new screen](https://docs.zeplin.dev/reference/createscreen.md): Create a new screen in the project
- [Get a single screen](https://docs.zeplin.dev/reference/getscreen.md): Get a single screen by id
- [Update a screen](https://docs.zeplin.dev/reference/updatescreen.md): Update a screen's description
- [Get screen components](https://docs.zeplin.dev/reference/getscreencomponents.md): List all components in the screen
- [Get screen notes](https://docs.zeplin.dev/reference/getscreennotes.md): List all notes in the screen
- [Create a note](https://docs.zeplin.dev/reference/createscreennote.md): Create a note on the screen
- [Get a single screen note](https://docs.zeplin.dev/reference/getscreennote.md): Get a screen note by id
- [Update a note](https://docs.zeplin.dev/reference/updatescreennote.md): Update a note on the screen
- [Delete a note](https://docs.zeplin.dev/reference/deletescreennote.md): Delete a note on the screen
- [Create a comment](https://docs.zeplin.dev/reference/createscreencomment.md): Create comment on the screen note
- [Update comment](https://docs.zeplin.dev/reference/updatescreencomment.md): Update comments on the screen note
- [Delete comment](https://docs.zeplin.dev/reference/deletescreencomment.md): Delete a comment on the screen note
- [Get screen annotations](https://docs.zeplin.dev/reference/getscreenannotations.md): List all annotations in the screen
- [Create an annotation](https://docs.zeplin.dev/reference/createscreenannotation.md): Create an annotation on the screen
- [Get a single screen annotation](https://docs.zeplin.dev/reference/getscreenannotation.md): Get a screen annotation by id
- [Update an annotation](https://docs.zeplin.dev/reference/updatescreenannotation.md): Update an annotation on the screen
- [Delete an annotation](https://docs.zeplin.dev/reference/deletescreenannotation.md): Delete an annotation on the screen
- [Get screen annotation note types](https://docs.zeplin.dev/reference/getscreenannotationsnotetypes.md): List all annotation note types in the project
- [Get screen versions](https://docs.zeplin.dev/reference/getscreenversions.md): List all versions of the screen in a project
- [Create a new screen version](https://docs.zeplin.dev/reference/createscreenversion.md): Create a new screen version in the project
- [Get a single screen version](https://docs.zeplin.dev/reference/getscreenversion.md): Get details of the screen version
- [Get the latest screen version](https://docs.zeplin.dev/reference/getlatestscreenversion.md): Get details of the latest version
- [Get screen sections](https://docs.zeplin.dev/reference/getscreensections.md): List all screen sections of the project
- [Get a single screen section](https://docs.zeplin.dev/reference/getscreensection.md): Get a screen section by id
- [Get screen variants](https://docs.zeplin.dev/reference/getscreenvariants.md): List all screen variants of the project
- [Get a single screen variant](https://docs.zeplin.dev/reference/getscreenvariant.md): Get a screen variant by id
- [Get project colors](https://docs.zeplin.dev/reference/getprojectcolors.md): This endpoint returns all of the colors in a project.  You need to be a member of the project or a member of the organization that owns the project. Returns `Not Found` response otherwise.
- [Create project color](https://docs.zeplin.dev/reference/createprojectcolor.md): Create a color in the project's local styleguide
- [Update project color](https://docs.zeplin.dev/reference/updateprojectcolor.md): Update a color in the project's local styleguide
- [Get styleguide colors](https://docs.zeplin.dev/reference/getstyleguidecolors.md): Returns colors in a styleguide that user has access.  See [Styleguide docs](#getstyleguide) for more details about how `linked_project` and `linked_styleguide` parameters can be used to retrieve…
- [Create styleguide color](https://docs.zeplin.dev/reference/createstyleguidecolor.md): Create a color in the styleguide's local styleguide
- [Update styleguide color](https://docs.zeplin.dev/reference/updatestyleguidecolor.md): Update a color in the styleguide
- [Get project text styles](https://docs.zeplin.dev/reference/getprojecttextstyles.md): List all text styles in the project's local styleguide
- [Update project text style](https://docs.zeplin.dev/reference/updateprojecttextstyle.md): Update a text style in the project's local styleguide
- [Get styleguide text styles](https://docs.zeplin.dev/reference/getstyleguidetextstyles.md): Returns the text styles of the styleguide that user has access.  See [Styleguide docs](#getstyleguide) for more details about how `linked_project` and `linked_styleguide` parameters can be used to…
- [Update styleguide text style](https://docs.zeplin.dev/reference/updatestyleguidetextstyle.md): Update a text style in the styleguide
- [Get project connected components](https://docs.zeplin.dev/reference/getprojectconnectedcomponents.md): List all connected components of a project
- [Get styleguide connected components](https://docs.zeplin.dev/reference/getstyleguideconnectedcomponents.md): List all connected components of a project
- [Get project components](https://docs.zeplin.dev/reference/getprojectcomponents.md): List all components of a project
- [Get a single project component](https://docs.zeplin.dev/reference/getprojectcomponent.md): Get a project component by id
- [Update a project component](https://docs.zeplin.dev/reference/updateprojectcomponent.md): Update a component's description in a project
- [Get latest project component version](https://docs.zeplin.dev/reference/getprojectcomponentlatestversion.md): Get latest version of the component in a project
- [Get project component sections](https://docs.zeplin.dev/reference/getprojectcomponentsections.md): List all component sections of the project
- [Get project pages](https://docs.zeplin.dev/reference/getprojectpages.md): List all pages of the project
- [Get styleguide components](https://docs.zeplin.dev/reference/getstyleguidecomponents.md): Returns components in a styleguide that user has access.  See [Styleguide docs](#getstyleguide) for more details about how `linked_project` and `linked_styleguide` parameters can be used to retrieve…
- [Get a single styleguide component](https://docs.zeplin.dev/reference/getstyleguidecomponent.md): Returns the component in a styleguide that user has access.  See [Styleguide docs](#getstyleguide) for more details about how `linked_project` and `linked_styleguide` parameters can be used to…
- [Update a styleguide component](https://docs.zeplin.dev/reference/updatestyleguidecomponent.md): Update a component's description in a styleguide
- [Get latest styleguide component version](https://docs.zeplin.dev/reference/getstyleguidecomponentlatestversion.md): Returns the latest version of the component in a styleguide that user has access.  See [Styleguide docs](#getstyleguide) for more details about how `linked_project` and `linked_styleguide` parameters…
- [Get styleguide component sections](https://docs.zeplin.dev/reference/getstyleguidecomponentsections.md): Returns the component sections of a styleguide that user has access.  See [Styleguide docs](#getstyleguide) for more details about how `linked_project` and `linked_styleguide` parameters can be used…
- [Get styleguide pages](https://docs.zeplin.dev/reference/getstyleguidepages.md): List all pages of the styleguide
- [Get spacing tokens of the project](https://docs.zeplin.dev/reference/getprojectspacingtokens.md): List all spacing tokens of the project
- [Update project spacing token](https://docs.zeplin.dev/reference/updateprojectspacingtoken.md): Update a spacing token in the project's local styleguide
- [Get spacing sections of the project](https://docs.zeplin.dev/reference/getprojectspacingsections.md): List all spacing sections of the project
- [Get spacing tokens of the styleguide](https://docs.zeplin.dev/reference/getstyleguidespacingtokens.md): List all spacing tokens of the styleguide that user has access.  See [Styleguide docs](#getstyleguide) for more details about how `linked_project` and `linked_styleguide` parameters can be used to…
- [Update styleguide spacing token](https://docs.zeplin.dev/reference/updatestyleguidespacingtoken.md): Update a spacing token in the styleguide
- [Get spacing sections of the styleguide](https://docs.zeplin.dev/reference/getstyleguidespacingsections.md): List all spacing sections of the styleguide that user has access.  See [Styleguide docs](#getstyleguide) for more details about how `linked_project` and `linked_styleguide` parameters can be used to…
- [Get project design tokens](https://docs.zeplin.dev/reference/getprojectdesigntokens.md): Fetch all design tokens of the project
- [Get styleguide design tokens](https://docs.zeplin.dev/reference/getstyleguidedesigntokens.md): Fetch all design tokens of the styleguide
- [Get project flow boards](https://docs.zeplin.dev/reference/getprojectflowboards.md): List all flow boards in a project.
- [Get a single project flow board](https://docs.zeplin.dev/reference/getprojectflowboard.md): Get flow board details related to a project
- [Get project flow board groups](https://docs.zeplin.dev/reference/getprojectflowboardgroups.md): List all flow board groups in a project.
- [Get project flow board connectors](https://docs.zeplin.dev/reference/getprojectflowboardconnectors.md): List all connectors of the flow board in a project
- [Get a single project flow board connector](https://docs.zeplin.dev/reference/getprojectflowboardconnector.md): Get details of the project flow board connector
- [Get project flow board nodes](https://docs.zeplin.dev/reference/getprojectflowboardnodes.md): List all nodes of the flow board in a project
- [Get a single project flow board node](https://docs.zeplin.dev/reference/getprojectflowboardnode.md): Get details of the project flow board node
- [Get project variable collections](https://docs.zeplin.dev/reference/getprojectvariablecollections.md): This endpoint returns all of the color variables in a project  You need to be a member of the project or a member of the organization that owns the project. Returns `Not Found` response otherwise.
- [Get styleguide variable collections](https://docs.zeplin.dev/reference/getstyleguidevariablecollections.md): This endpoint returns all of the color variables in a styleguide  You need to be a member of the styleguide or a member of the organization that owns the styleguide. Returns `Not Found` response…
- [Get all member styleguides](https://docs.zeplin.dev/reference/getstyleguides.md): Lists all styleguides user is a member of unless `linked_project` or `linked_styleguide` parameter is given.  If `linked_project` parameter is provided, lists styleguide linked to the given project…
- [Get a single styleguide](https://docs.zeplin.dev/reference/getstyleguide.md): Returns a single styleguide that user has access.  User is considered eligible to access a styleguide if any of the following conditions is met: * User is a member of the styleguide * User is a…
- [Update a styleguide](https://docs.zeplin.dev/reference/updatestyleguide.md): Update a styleguide's name and description
- [Get styleguide members](https://docs.zeplin.dev/reference/getstyleguidemembers.md): Returns members of a styleguide that user has access.  See [Styleguide docs](#getstyleguide) for more details about how `linked_project` and `linked_styleguide` parameters can be used to retrieve…
- [Invite a member](https://docs.zeplin.dev/reference/invitestyleguidemember.md): Invite a member to the styleguide.
- [Remove a member](https://docs.zeplin.dev/reference/removestyleguidemember.md): Remove a member from the styleguide.
- [Get linked projects](https://docs.zeplin.dev/reference/getstyleguidelinkedprojects.md): List all projects linked to the styleguide
- [Current user](https://docs.zeplin.dev/reference/getcurrentuser.md): Get current user's details
- [Get personal projects](https://docs.zeplin.dev/reference/getuserprojects.md): List all projects that belong to the current user
- [Get personal styleguides](https://docs.zeplin.dev/reference/getuserstyleguides.md): List all styleguides that belong to the current user
- [Get user notifications](https://docs.zeplin.dev/reference/getusernotifications.md): List all notifications of the user
- [Bulk update user notifications](https://docs.zeplin.dev/reference/updateusernotifications.md): Updates all user notifications unless `type` or `id` parameter is given.  If `type` parameter is provided, updates notifications with matching type.  Similarly, updates notifications with matching…
- [Get a notification of user](https://docs.zeplin.dev/reference/getusernotification.md): Get a notification by id
- [Update user notification](https://docs.zeplin.dev/reference/updateusernotification.md): Update a notification for the user

## API Reference: Webhook Events
- [Overview](https://docs.zeplin.dev/reference/webhook-events-overview.md)
- [Project Screen](https://docs.zeplin.dev/reference/project_screen_event.md)
- [Project Screen Version](https://docs.zeplin.dev/reference/project_screen_version_event.md)
- [Project Note](https://docs.zeplin.dev/reference/project_note_event.md)
- [Project Note Comment](https://docs.zeplin.dev/reference/project_note_comment_event.md)
- [Project Color](https://docs.zeplin.dev/reference/project_color_event.md)
- [Styleguide Color](https://docs.zeplin.dev/reference/styleguide_color_event.md)

## API Reference: Models
- [Color](https://docs.zeplin.dev/reference/color.md)
- [Flow Board Annotation Node](https://docs.zeplin.dev/reference/flow_board_annotation_node.md)
- [Note Types](https://docs.zeplin.dev/reference/note_types.md)
- [Organization Webhook Event Type](https://docs.zeplin.dev/reference/organization_webhook_event_type.md)
- [Page](https://docs.zeplin.dev/reference/page.md)
- [Project Webhook Event Type](https://docs.zeplin.dev/reference/project_webhook_event_type.md)
- [Screen](https://docs.zeplin.dev/reference/screen.md)
- [Screen Annotation](https://docs.zeplin.dev/reference/screen_annotation.md)
  - [Screen Annotation Color](https://docs.zeplin.dev/reference/screen_annotation_color.md)
  - [Screen Annotation Note Type](https://docs.zeplin.dev/reference/screen_annotation_note_type.md)
  - [Screen Annotation Position](https://docs.zeplin.dev/reference/screen_annotation_position.md)
- [Screen Note](https://docs.zeplin.dev/reference/screen_note.md)
  - [Screen Note Position](https://docs.zeplin.dev/reference/screen_note_position.md)
- [Screen Note Comment](https://docs.zeplin.dev/reference/screen_note_comment.md)
- [Source](https://docs.zeplin.dev/reference/source.md)
- [User Webhook Event Type](https://docs.zeplin.dev/reference/user_webhook_event_type.md)
- [Variable Collection](https://docs.zeplin.dev/reference/variable_collection.md)
  - [Variable](https://docs.zeplin.dev/reference/variable.md)
  - [Variable Info](https://docs.zeplin.dev/reference/variable_info.md)
  - [Variable Group](https://docs.zeplin.dev/reference/variable_group.md)
  - [Variable Mode](https://docs.zeplin.dev/reference/variable_mode.md)
  - [Variable value](https://docs.zeplin.dev/reference/variable_value.md)
- [Layer Constraints](https://docs.zeplin.dev/reference/layer_constraints.md)
- [Layer Corner Radius](https://docs.zeplin.dev/reference/layer_corner_radius.md)
- [Layer Grid Size](https://docs.zeplin.dev/reference/layer_grid_size.md)
- [Layer Layout](https://docs.zeplin.dev/reference/layer_layout.md)

## Changelog
- [May 11, 2021 - Update spacing tokens](https://docs.zeplin.dev/changelog/may-11-2021.md)
- [April 8, 2021](https://docs.zeplin.dev/changelog/april-8-2021.md)
- [March 31, 2021 - Design Tokens](https://docs.zeplin.dev/changelog/march-31-2021-design-tokens.md)
- [March 26, 2021 - User's last seen time](https://docs.zeplin.dev/changelog/march-26-2021-users-last-seen-time.md)
- [March 8, 2021 - Component variants](https://docs.zeplin.dev/changelog/march-8-2021-component-variants.md)
- [February 11, 2021 - Team Management API](https://docs.zeplin.dev/changelog/february-11-2021-team-management-api.md)
- [February 11, 2021 - Bulk notification update](https://docs.zeplin.dev/changelog/february-11-2021-bulk-notification-update.md)
- [January 25, 2021 - Notifications](https://docs.zeplin.dev/changelog/january-25-2021-notifications.md)
- [January 6, 2021 - Workflow status for projects](https://docs.zeplin.dev/changelog/january-6-2021-workflow-status-for-projects.md)
- [October 7, 2020 - Thumbnail images](https://docs.zeplin.dev/changelog/october-7-2020-thumbnail-images.md)