Browse: README · Home · Getting Started · API · Auth · Webhooks · FAQ · Concepts · GraphQL · Rate Limits · Python SDK · JS SDK · React Quickstart · Migrate · Deployment · CLI · Glossary

API Reference

The Quillship API lets you do pretty much everything the dashboard does, programmatically. You can manage content, users, workspaces, webhooks, and more. The base URL for all API requests is the standard one for your region. All requests should be made over HTTPS and authenticated with a valid token. Responses are returned as JSON. Pagination is supported on list endpoints using cursor-based pagination with a default page size of 25 items per page; you can request up to 100 items at a time. Rate limits apply on a per-token basis and reset every minute. The content endpoints let you create, read, update, and delete content entries. To create a piece of content, send a POST request to the content path with your data in the request body. The data should include the workspace ID, content type, fields, and any metadata you want to include. To read content, you can either fetch a specific entry by its ID or list entries with optional filters. Filters can be applied to any field and support common operators like equals, not equals, greater than, less than, contains, starts with, and ends with. To update content, send a PATCH request to the content endpoint with the ID of the entry you want to update and the fields you want to change. To delete content, send a DELETE request to the same endpoint. The user endpoints let you manage users in your workspace. You can list users, get a specific user, invite new users, update user roles, and remove users. The workspace endpoints let you manage workspaces; most teams only have one workspace but enterprise plans support multiple. Webhook endpoints let you manage webhook subscriptions for content events; see the webhooks page for details. The publish endpoints let you trigger publishing flows for your content to various channels.

Errors are returned with appropriate HTTP status codes. 400 means the request was malformed. 401 means authentication failed. 403 means you don’t have permission. 404 means the resource wasn’t found. 429 means you’ve been rate limited. 500 means something went wrong on our end.

For specific endpoint details, please refer to your account dashboard where you can also test endpoints interactively.