Skip to main content
Server path: /zeplin-admin | Type: Application | PCID required: Yes

Tools

ToolDescription
zeplin_admin_create_organization_webhooksCreate organization webhooks
zeplin_admin_create_project_webhooksCreate project webhooks
zeplin_admin_create_styleguide_webhooksCreate styleguide webhooks
zeplin_admin_create_user_webhooksCreate user webhooks
zeplin_admin_delete_organization_webhookDelete a webhook of an organization
zeplin_admin_delete_project_webhookDelete a webhook of a project
zeplin_admin_delete_styleguide_webhookDelete a webhook of a styleguide
zeplin_admin_delete_user_webhookDelete a webhook of a user
zeplin_admin_get_current_userCurrent user
zeplin_admin_get_organizationGet a single organization
zeplin_admin_get_organization_aliensGet organization aliens
zeplin_admin_get_organization_billingGet organization billing details
zeplin_admin_get_organization_member_projectsGet a member’s projects
zeplin_admin_get_organization_member_styleguidesGet a member’s styleguides
zeplin_admin_get_organization_membersGet organization members
zeplin_admin_get_organization_projectsGet organization projects
zeplin_admin_get_organization_styleguidesGet organization styleguides
zeplin_admin_get_organization_webhookGet a webhook of organization
zeplin_admin_get_organization_webhooksGet organization webhooks
zeplin_admin_get_organization_workflow_statusesGet organization workflow statuses
zeplin_admin_get_organizationsGet organizations
zeplin_admin_get_projectGet a single project
zeplin_admin_get_project_membersGet project members
zeplin_admin_get_project_webhookGet a webhook of project
zeplin_admin_get_project_webhooksGet project webhooks
zeplin_admin_get_projectsGet all projects
zeplin_admin_get_styleguide_webhookGet a webhook of styleguide
zeplin_admin_get_styleguide_webhooksGet styleguide webhooks
zeplin_admin_get_user_notificationGet a notification of user
zeplin_admin_get_user_notificationsGet user notifications
zeplin_admin_get_user_projectsGet personal projects
zeplin_admin_get_user_styleguidesGet personal styleguides
zeplin_admin_get_user_webhookGet a webhook of user
zeplin_admin_get_user_webhooksGet user webhooks
zeplin_admin_invite_organization_memberInvite member
zeplin_admin_invite_project_memberInvite a member
zeplin_admin_remove_organization_memberRemove an organization member
zeplin_admin_remove_project_memberRemove a member
zeplin_admin_update_organization_memberUpdate an organization member
zeplin_admin_update_organization_webhooksUpdate organization webhooks
zeplin_admin_update_projectUpdate a project
zeplin_admin_update_project_webhooksUpdate project webhooks
zeplin_admin_update_styleguide_webhooksUpdate styleguide webhooks
zeplin_admin_update_user_notificationUpdate user notification
zeplin_admin_update_user_notificationsBulk update user notifications
zeplin_admin_update_user_webhooksUpdate user webhooks

zeplin_admin_create_organization_webhooks

Create organization webhooks Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
eventsstring[]YesThe events of the webhook
namestringNoThe name of the webhook
project_idsstring[]YesThe project ids of the webhook
secretstringYesThe secret to be used to generate signatures for webhook requests
statusstringNoThe status of the webhook
styleguide_idsstring[]YesThe styleguide ids of the webhook
urlstringYesThe URL of the webhook

zeplin_admin_create_project_webhooks

Create project webhooks Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
eventsstring[]YesThe events of the webhook
namestringNoThe name of the webhook
secretstringYesThe secret to be used to generate signatures for webhook requests
statusstringNoThe status of the webhook
urlstringYesThe URL of the webhook

zeplin_admin_create_styleguide_webhooks

Create styleguide webhooks Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
eventsstring[]YesThe events of the webhook
namestringNoThe name of the webhook
secretstringYesThe secret to be used to generate signatures for webhook requests
statusstringNoThe status of the webhook
urlstringYesThe URL of the webhook

zeplin_admin_create_user_webhooks

Create user webhooks Parameters:
ParameterTypeRequiredDefaultDescription
eventsstring[]YesThe events of the webhook
namestringNoThe name of the webhook
project_idsstring[]YesThe project ids of the webhook
secretstringYesThe secret to be used to generate signatures for webhook requests
statusstringNoThe status of the webhook
styleguide_idsstring[]YesThe styleguide ids of the webhook
urlstringYesThe URL of the webhook

zeplin_admin_delete_organization_webhook

Delete a webhook of an organization Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
webhook_idstringYesWebhook id

zeplin_admin_delete_project_webhook

Delete a webhook of a project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
webhook_idstringYesWebhook id

zeplin_admin_delete_styleguide_webhook

Delete a webhook of a styleguide Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
webhook_idstringYesWebhook id

zeplin_admin_delete_user_webhook

Delete a webhook of a user Parameters:
ParameterTypeRequiredDefaultDescription
webhook_idstringYesWebhook id

zeplin_admin_get_current_user

Current user

zeplin_admin_get_organization

Get a single organization Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id

zeplin_admin_get_organization_aliens

Get organization aliens Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id

zeplin_admin_get_organization_billing

Get organization billing details Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id

zeplin_admin_get_organization_member_projects

Get a member’s projects Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
member_idstringYesMember id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_admin_get_organization_member_styleguides

Get a member’s styleguides Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
member_idstringYesMember id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_admin_get_organization_members

Get organization members Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
limitintegerNoPagination limit
offsetintegerNoPagination offset
handlestring[]NoFilter organization members by email, username or unique identifier of the user ☝️Note that only organization admins (or higher) can filter members using email addresses. Example: ?handle=zozo&handle=5d9caaecb4a3fa9bc9718686&handle=zozo%40zeplin.io

zeplin_admin_get_organization_projects

Get organization projects Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_admin_get_organization_styleguides

Get organization styleguides Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_admin_get_organization_webhook

Get a webhook of organization Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
webhook_idstringYesWebhook id

zeplin_admin_get_organization_webhooks

Get organization webhooks Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
limitintegerNoPagination limit
offsetintegerNoPagination offset
statusstringNoFilter by webhook status
url_healthstringNoFilter by health of webhook’s URL

zeplin_admin_get_organization_workflow_statuses

Get organization workflow statuses Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id

zeplin_admin_get_organizations

Get organizations Parameters:
ParameterTypeRequiredDefaultDescription
rolestring[]NoFilter by role ☝️Note that the Developer role maps to member and the Reviewer role maps to alien in the API. Example: ?role=owner&role=admin

zeplin_admin_get_project

Get a single project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id

zeplin_admin_get_project_members

Get project members Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
limitintegerNoPagination limit
offsetintegerNoPagination offset

zeplin_admin_get_project_webhook

Get a webhook of project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
webhook_idstringYesWebhook id

zeplin_admin_get_project_webhooks

Get project webhooks Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
limitintegerNoPagination limit
offsetintegerNoPagination offset
statusstringNoFilter by webhook status
url_healthstringNoFilter by health of webhook’s URL

zeplin_admin_get_projects

Get all projects Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoPagination limit
workspacestringNoWorkspace of the project, it can be personal or the id of organization
statusstringNoFilter by status
offsetintegerNoPagination offset

zeplin_admin_get_styleguide_webhook

Get a webhook of styleguide Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
webhook_idstringYesWebhook id

zeplin_admin_get_styleguide_webhooks

Get styleguide webhooks Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
limitintegerNoPagination limit
offsetintegerNoPagination offset
statusstringNoFilter by webhook status
url_healthstringNoFilter by health of webhook’s URL

zeplin_admin_get_user_notification

Get a notification of user Parameters:
ParameterTypeRequiredDefaultDescription
notification_idstringYesNotification id

zeplin_admin_get_user_notifications

Get user notifications Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoPagination limit
offsetintegerNoPagination offset
is_readbooleanNoWhether the notification is read or not
typestring[]NoFilter by type Example: ?type=project.extension&type=styleguide.extension

zeplin_admin_get_user_projects

Get personal projects Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoPagination limit
offsetintegerNoPagination offset
statusstringNoFilter by status

zeplin_admin_get_user_styleguides

Get personal styleguides Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoPagination limit
offsetintegerNoPagination offset
statusstringNoFilter by status

zeplin_admin_get_user_webhook

Get a webhook of user Parameters:
ParameterTypeRequiredDefaultDescription
webhook_idstringYesWebhook id

zeplin_admin_get_user_webhooks

Get user webhooks Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoPagination limit
offsetintegerNoPagination offset
statusstringNoFilter by webhook status
url_healthstringNoFilter by health of webhook’s URL

zeplin_admin_invite_organization_member

Invite member Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
handlestringYesEmail, username or unique identifier of the user
restrictedbooleanYesWhether the user’s membership is restricted to only the projects that they are member of
rolestringYesThe role of the user in the organization ☝️Note that the Developer role maps to member and the Reviewer role maps to alien in the API.
tagsstring[]NoTags of the user in the organization

zeplin_admin_invite_project_member

Invite a member Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
handlestringYesEmail, username or unique identifier of the user Can also be "me" for joining the project as the current user

zeplin_admin_remove_organization_member

Remove an organization member Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
member_idstringYesMember id

zeplin_admin_remove_project_member

Remove a member Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
member_idstringYesMember id

zeplin_admin_update_organization_member

Update an organization member Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
member_idstringYesMember id
restrictedbooleanNoWhether the user’s membership is restricted to only the
rolestringNoThe role of the user in the organization ☝️Note that the Developer role maps to member and the Reviewer role maps to alien in the API.
tagsstring[]NoTags of the user in the organization

zeplin_admin_update_organization_webhooks

Update organization webhooks Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesOrganization id
webhook_idstringYesWebhook id
eventsstring[]NoThe events of the webhook
namestringNoThe name of the webhook
project_idsstring[]NoThe project ids of the webhook
secretstringNoThe secret to be used to generate signatures for webhook requests
statusstringNoThe status of the webhook
styleguide_idsstring[]NoThe styleguide ids of the webhook
urlstringNoThe URL of the webhook

zeplin_admin_update_project

Update a project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
descriptionstringNoNew description for the project
linked_styleguide_idstringNoThe unique id of the styleguide to be linked. Set null to unlink the linked styleguide.
namestringNoNew name for the project
workflow_status_idstringNoId of the new workflow status for the project

zeplin_admin_update_project_webhooks

Update project webhooks Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject id
webhook_idstringYesWebhook id
eventsstring[]NoThe events of the webhook
namestringNoThe name of the webhook
secretstringNoThe secret to be used to generate signatures for webhook requests
statusstringNoThe status of the webhook
urlstringNoThe URL of the webhook

zeplin_admin_update_styleguide_webhooks

Update styleguide webhooks Parameters:
ParameterTypeRequiredDefaultDescription
styleguide_idstringYesStyleguide id
webhook_idstringYesWebhook id
eventsstring[]NoThe events of the webhook
namestringNoThe name of the webhook
secretstringNoThe secret to be used to generate signatures for webhook requests
statusstringNoThe status of the webhook
urlstringNoThe URL of the webhook

zeplin_admin_update_user_notification

Update user notification Parameters:
ParameterTypeRequiredDefaultDescription
notification_idstringYesNotification id
is_readbooleanYesNew is_read status for notifications

zeplin_admin_update_user_notifications

Bulk update user notifications Parameters:
ParameterTypeRequiredDefaultDescription
typestring[]NoFilter by type Example: ?type=project.extension&type=styleguide.extension
idstring[]NoFilter by id Example: ?id=5fbe387f8c72ef23659fb500&id=602281f4783f72fccc045484
is_readbooleanYesNew is_read status for notifications

zeplin_admin_update_user_webhooks

Update user webhooks Parameters:
ParameterTypeRequiredDefaultDescription
webhook_idstringYesWebhook id
eventsstring[]NoThe events of the webhook
namestringNoThe name of the webhook
project_idsstring[]NoThe project ids of the webhook
secretstringNoThe secret to be used to generate signatures for webhook requests
statusstringNoThe status of the webhook
styleguide_idsstring[]NoThe styleguide ids of the webhook
urlstringNoThe URL of the webhook