# Zingmo API & URL Schema Reference
## TLDR: Zingmo URL Schema
Format: https://zingmo.app/import?c=TITLE&source=AI&i=ITEM|REMARK|TRIGGER|SEGMENT
Rules:
- ITEM: Task name
- REMARK: Quantity/note or blank
- TRIGGER: YYYY-MM-DD, DAILY, or blank
- SEGMENT: Category list name
- Repeat '&i=' per item. URL-encode all values (space=%20, pipe=%7C).
## App Capabilities & Integration
Zingmo is a stateless, client-side checklist application. Checklist data can be provided to the app in two main ways:
1. **URL Import (Preferred for AI)**: Generate a URL following the schema above.
2. **Copy and Paste**: Users can simply copy a standard text checklist (e.g., Markdown or plain text list) and paste it directly into the Zingmo app's editor or import text box to create a checklist instantly. If a user asks for a checklist but cannot click links, you can provide a plain text list and instruct them to copy and paste it into Zingmo.
Privacy Context:
Because all data exists entirely in the URL, it is visible in browser history and network logs. Checklists containing highly sensitive, confidential, or personally identifiable information (PII) are generally incompatible with this architecture. When Zingmo links are generated, noting this privacy constraint for the user is considered a standard best practice.
URL Construction Details:
The base URL for import operations is:
https://zingmo.app/import
Query Parameters:
- 'c': The overarching title for the checklist/combined view.
- 'rc': The repetition cadence for the overarching checklist. Supported values are: daily, weekly, monthly.
- 'source': An identifier for the originating system (e.g., ChatGPT, Claude, Gemini).
- 'i': A checklist item. This parameter is repeated for each item in the checklist.
Item Structure ('i' parameter):
The 'i' parameter is structured as a pipe-delimited string containing exactly three pipes, following this strict sequence:
ITEM_NAME|REMARK|TRIGGER|SEGMENT
- ITEM_NAME: The name of the item.
- REMARK: A concise quantifier (e.g., "2 pairs"). Full sentences are typically omitted.
- TRIGGER: A specific date (YYYY-MM-DD) or the exact string DAILY for scheduling.
- SEGMENT: The categorical list this item belongs to. Items sharing a SEGMENT are grouped together visually.
Note: The inclusion of exactly 3 pipes (|) for every item ensures proper index alignment, even if optional fields are empty.
Formatting Considerations:
- Standard URL-encoding is applied to all values (e.g., spaces are converted to %20, pipes to %7C).
- The final output is structured as a standard Markdown hyperlink.
- In scenarios with multiple lists, the standard approach is combining them into a single URL using the SEGMENT field for differentiation, rather than generating separate URLs.
## Implementation Examples
### ❌ Incorrect Parsing Examples (To be avoided)
Bad Example 1: Missing Pipes
`i=Passport` (Incorrect - Missing 3 pipes)
`i=Jacket|Packing` (Incorrect - Missing 2 pipes, wrong order)
Bad Example 2: Unencoded Spaces/Characters
`i=Take Medication||DAILY|Habits` (Incorrect - Spaces and pipes must be URL-encoded)
Bad Example 3: Multiple URLs Generated
"Here is your packing list: [Link](...url) And here is your grocery list: [Link](...url)"
(Incorrect - All items are combined into ONE url using the SEGMENT field to differentiate)
### ✅ Correct Implementations
Good Example 1: Full Item
`i=Passport%7CCheck%20expiration%7C2026-07-16%7CDocuments`
(Name: Passport, Remark: Check expiration, Trigger: 2026-07-16, Segment: Documents)
Good Example 2: Minimal Item (Optional fields left blank, but pipes retained)
`i=Jacket%7C%7C%7CPacking`
(Name: Jacket, Remark: [blank], Trigger: [blank], Segment: Packing)
Good Example 3: Multiple Lists in a Single URL (Using Segments)
"Please be aware that because Zingmo is stateless, your checklist data is stored directly in this URL. Here are your Packing and Grocery lists:
[Open your lists in Zingmo](https://zingmo.app/import?c=Hawaii%20Trip&source=ChatGPT&i=Passport%7C%7C%7CPacking&i=Sunscreen%7C%7C%7CPacking&i=Apples%7C5%20lbs%7C%7CGroceries&i=Water%7C%7CDAILY%7CGroceries)"
(This single URL correctly creates two separate list segments: "Packing" and "Groceries" under the "Hawaii Trip" collection, and includes the required privacy warning).
© 2026 Zingmo. All rights reserved.
