Publications API
Create, update, delete, and manage flipbook publications. Upload PDFs, control visibility, manage versions, and generate QR codes.
- List Publications
- Query Parameters
- Example Request
- Example Response
- Create Publication
- Request Body
- Example Request
- Example Response
- Upload PDF
- Example Request
- Example Response
- Get Publication
- Example Request
- Example Response
- Update Publication
- Request Body
- Example Request
- Update Publication Settings
- Example Request
- Update Publication Branding
- Example Request
- Publish / Archive
- Delete Publication
- List Versions
- Example Response
- Activate Version
- Generate QR Code
- Public Viewer Endpoint
Publications API
The Publications API lets you create flipbook publications, upload PDFs for conversion, manage versions, and control access settings. All endpoints require authentication unless marked as public.
Base URL: https://api.zenflip.io/v1/publications
List Publications
Retrieve a paginated list of publications in your organization.
Query Parameters
Parameter | Type | Required | Description |
| integer | No | Page number (default: 1) |
| integer | No | Items per page (default: 20) |
| string | No | Filter by title (partial match) |
| string | No | Filter by status: |
| string | No | Field to sort by (e.g., |
| string | No | Sort direction: |
Example Request
Example Response
Create Publication
Create a new publication record. After creation, upload a PDF to generate flipbook pages.
Required role: editor or above.
Request Body
Field | Type | Required | Description |
| string | Yes | Publication title (1--200 characters) |
| string | No | Short description of the publication |
Example Request
Example Response
Upload PDF
Upload a PDF file to create a new version of a publication. The PDF is stored in S3 and a background conversion job is queued to generate flipbook pages.
Required role: editor or above. Maximum file size: 200 MB. Only PDF files are accepted.
Example Request
Example Response
The version status progresses through: uploading -> uploaded -> converting -> ready (or failed). Use the Get Publication endpoint to check the active version status.
Get Publication
Retrieve a single publication by ID.
Example Request
Example Response
Update Publication
Update a publication's metadata.
Required role: editor or above.
Request Body
Field | Type | Required | Description |
| string | No | Publication title (1--200 characters) |
| string | No | Short description |
| string | No | URL-friendly slug (1--200 characters) |
Example Request
Update Publication Settings
Update the viewer settings for a publication (page mode, auto-play, toolbar visibility, etc.).
Required role: editor or above.
Example Request
Update Publication Branding
Apply custom branding (logo, colors, fonts) to a publication. Requires the customBranding feature on your plan.
Required role: editor or above. Required plan feature: customBranding.
Example Request
Publish / Archive
Change the publication lifecycle status:
Delete Publication
Permanently delete a publication and all associated data (versions, pages, analytics).
Required role: admin or above.
List Versions
Retrieve all versions of a publication.
Example Response
Activate Version
Switch the active (live) version of a publication to a previously uploaded version.
Required role: editor or above.
Generate QR Code
Generate a PNG QR code that links to the publication viewer.
Returns a 512x512 PNG image directly (Content-Type: image/png).
Public Viewer Endpoint
Retrieve publication data for the public flipbook viewer. No authentication required.
This endpoint is rate-limited to 60 requests per minute per IP and returns the publication with resolved page image URLs for rendering in the viewer.