zipBoard API: Connect zipBoard to Your Own Systems

Use the zipBoard API to put zipBoard's review and markup layer inside the systems your team already runs: SAP or another ERP, a document management system, your project tools, or your reporting dashboards. Your system sends documents to zipBoard for review, then pulls the review status, tasks and comments back, so approvals aren't stuck in a separate tool. The full, current reference is at docs.zipboard.co. This page covers common integration patterns, how to get an API key, and what each part of the API does.

Looking for an older API article? Our earlier articles (API for Project, Files, Review Links, Tasks, Feedback, Organization, Responses, HTTP Status Codes, and API Authentication) described a previous version of the API. They now redirect here. Use the links below for the current reference.

Common integration patterns

1. A review layer inside your ERP or document management system

Your drawings, submittals, specs and other documents stay organized in your system of record, such as SAP. When a document needs review, your system sends it to zipBoard (as a hosted PDF URL), picks or creates the project, and creates a share link for the reviewers. Reviewers mark up and comment in zipBoard. Your system then pulls the tasks, comments and replies back, so review progress and delays show up in your own reports.

Uses: Projects, Files, Share URLs, Tasks, Comments, Responses

2. Set up review projects automatically

When a new job, project or course is created in your project management system, the integration creates the matching zipBoard project and its share links, so every review starts with the same setup and no manual steps.

Uses: Projects, Share URLs

3. Feed review data into dashboards and other tools

Pull tasks, comments and replies on a schedule into BI dashboards, an issue tracker or an LMS. Then you can report on open items and recurring issues across all your projects in one place.

Uses: Tasks, Comments, Responses

Planning an integration? Email support@zipboard.co with the system you want to connect, and our team will walk through the approach with you.

What you can do with the API

Area	What it covers	Reference
Projects	List, create, update and delete projects in your organization	Projects
Collaborators	See and remove the people on a project	Collaborators
Files	Add website URLs and hosted PDFs for review, list all uploads, update or delete files	Files
Tasks	Create, update, assign and delete tasks (issues)	Tasks
Comments	Read and add comments (feedback) that aren't tasks	Comments
Responses	Replies on tasks and comments	Responses
Annotations	Drawings and markup on screenshots and PDFs	Annotations
Screenshots and videos	Screenshot and video uploads, plus account limits	Screenshots
Share URLs	Create and manage review (share) links	Share URLs
Users	User details and authentication	Users
Organizations	Organization details	Organizations

The API accepts website URLs and hosted PDF URLs. Other file types (images, videos, SCORM packages and so on) are uploaded in the zipBoard app.

Get your API key

Sign in to zipBoard.
Click your name or user icon in the top-right corner and choose Edit Profile.
Scroll to the API Key section and click the generate/refresh icon to create a key. Refreshing creates a new key, and the old one stops working.
Copy the key and store it on your server, for example in an environment variable.

All requests go to https://app.zipboard.co and send your key in the Authorization header, as described in the Authentication section of the reference.

Keep your API key private. Call the API from your server, never from code that runs in a user's browser.

Example: list your organization's projects

A typical integration starts by fetching your organization's projects. Then it adds files to a project and syncs tasks and comments back into your own app. Here is a first request:

curl "https://app.zipboard.co/api/v1/project?orgid=YOUR_ORG_ID" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

The response lists the organization's projects as JSON. See Projects for every filter (by user, role or project ID) and the full response format.

HTTP status codes

Code	Meaning
200 OK	The request succeeded.
201 Created	The resource was created.
400 Bad Request	A parameter is missing or invalid. The error message says which one.
401 Unauthorized	The key or token is invalid, or the user isn't allowed to do this. Refresh your key and try again.
403 Forbidden	The action isn't permitted for this user or resource.
404 Not Found	The resource doesn't exist.
405 Method Not Allowed	That HTTP method isn't supported on this endpoint.

Prefer no code?

For common workflows you may not need the API. zipBoard connects directly with Jira, Wrike, Slack, Microsoft Teams, Procore and Zapier. See the Integrations section.

Questions about the API? Email support@zipboard.co.