API list
All 63 V2 endpoints, grouped by area. Each one is POST https://open.cli.im/api/v2/rpc/{path} with a JSON body. This page is generated from openapi.json, which holds the request fields of every endpoint.
- Minimum level is the lowest personal API key or OAuth level that can call the endpoint. The organization's maximum permission and the member's own access still apply.
- Organization key shows whether a legacy organization key can call it.
- Endpoints with a link have their own reference page. Pages marked "Chinese only" have no English version yet.
Credential and quota
Check which organization and permission level the credential has, and the organization's quota for the day.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| Current organization, effective permissions and capabilities (Chinese only) | auth/getContext | Read-only | Yes |
| Organization quota used today for MCP and API (Chinese only) | usage/get | Read-only | Yes |
Codes
List codes and read their content and operation panel.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| Get code content | qrcodes/getContent | Read-only | Yes |
| Operation items linked to a code | qrcodes/getOperation | Read-only | Yes |
| List codes (Chinese only) | qrcodes/list | Read-only | Yes |
Batch templates and sub-codes
Read batch templates and their sub-codes.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| List batch templates (Chinese only) | templates/list | Read-only | Yes |
| Get a batch template (Chinese only) | templates/get | Read-only | Yes |
| List sub-codes of a template (Chinese only) | templates/listQrcodes | Read-only | Yes |
| Get a sub-code (Chinese only) | templates/getSubcode | Read-only | Yes |
Forms and records
Read form structures and records, add records and verify certificates.
Step-by-step: Query forms and records linked to a QR code, Submit a record to a form under a QR code.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| Get form structure | forms/getTemplate | Read-only | Yes |
| Get a record | record/getRecord | Read-only | Yes |
| List records | record/getRecords | Read-only | Yes |
| List forms | record/getFormList | Read-only | Yes |
| Add a record | record/addRecord | Read/write | Yes |
| Verify a certificate | certificates/verify | Read/write | Yes |
| Follow-up activity on a record (Chinese only) | record/getActivities | Read-only | — |
| Search records for drill-down (Chinese only) | record/searchRecords | Read-only | Yes |
Projects
List the projects in the organization.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| List projects (Chinese only) | projects/list | Read-only | Yes |
Metrics
Read metric definitions and query results by dimension.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| Business objects and available metrics (Chinese only) | metrics/list | Read-only | Yes |
| Get a metric definition (Chinese only) | metrics/get | Read-only | Yes |
| Query a metric (Chinese only) | metrics/query | Read-only | Yes |
Official templates
Browse the official template library and create one code or a batch from a template.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| Official template categories (Chinese only) | gallery/categories | Read-only | — |
| Browse or search official templates (Chinese only) | gallery/list | Read-only | — |
| Get an official template (Chinese only) | gallery/get | Read-only | — |
| Prepare an official-template creation plan (Chinese only) | gallery/prepare-creation | Read/write | — |
| Create one code from an official template (Chinese only) | gallery/create-qrcode | Read/write | — |
| Run an official-template creation plan (Chinese only) | gallery/create-from-plan | Read/write | — |
Code creation and batch tasks
Create standard, redirect, multi-link and static codes. Prevalidate and submit batch creation from a template, then read task progress and per-item results.
Step-by-step: Create codes in bulk from a template.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| Prevalidate a batch without creating codes (Chinese only) | qrcodes/prevalidate | Read/write | — |
| Submit a batch creation task (Chinese only) | qrcodes/createBatch | Read/write | — |
| Get creation task progress (Chinese only) | qrcodeTasks/get | Read/write | — |
| Projects and folders you can create in (Chinese only) | qrcodes/listCreateTargets | Read-only | — |
| Per-item results of a batch task (Chinese only) | qrcodeTasks/getResults | Read/write | — |
| Create a standard code and link forms (Chinese only) | qrcodes/create | Read/write | — |
| Create a redirect code (Chinese only) | qrcodes/createUrlJump | Read/write | — |
| Create a multi-link code (Chinese only) | qrcodes/createMultiUrl | Read/write | — |
| Create a static text or URL code (Chinese only) | staticQrcodes/create | Read/write | — |
Edit and delete
Edit and delete codes and forms. Read the edit state for a version before editing. Deleting takes two calls: preview for a confirmation token, then delete with it.
Step-by-step: Edit and delete codes and forms.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| Code content, version and editability (Chinese only) | qrcodes/getEditState | Read/write | — |
| Edit a standard code (Chinese only) | qrcodes/edit | Read/write | — |
| Edit a redirect code (Chinese only) | qrcodes/editUrlJump | Read/write | — |
| Edit a multi-link code (Chinese only) | qrcodes/editMultiUrl | Read/write | — |
| Edit one sub-code (Chinese only) | qrcodeChildren/edit | Read/write | — |
| Form fields, version and editability (Chinese only) | forms/getEditState | Read/write | — |
| Edit a form's name or fields (Chinese only) | forms/edit | Read/write | — |
| Preview code deletion and get a token (Chinese only) | qrcodes/previewDelete | Full | — |
| Delete codes with a confirmation token (Chinese only) | qrcodes/delete | Full | — |
| Preview form deletion and get a token (Chinese only) | forms/previewDelete | Full | — |
| Delete forms with a confirmation token (Chinese only) | forms/delete | Full | — |
Template and form management
Find, create and edit templates, and create forms.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| Find templates you can create from or edit (Chinese only) | templates/listEditable | Read-only | — |
| Template fields and version for writing (Chinese only) | templates/getSchema | Read-only | — |
| Create a template (Chinese only) | templates/create | Read/write | — |
| Preview a template change and its impact (Chinese only) | templates/previewEdit | Read/write | — |
| Save template changes (Chinese only) | templates/edit | Read/write | — |
| Create a form, optionally with a schedule (Chinese only) | forms/create | Read/write | — |
File upload
Request a temporary upload for a local image or file and get the file_key to reference when creating codes.
Step-by-step: Create codes in bulk from a template.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| Request a temporary upload (Chinese only) | assets/requestUpload | Read/write | — |
| Get upload status (Chinese only) | assets/getUpload | Read/write | — |
Labels
Read the label style, then preview and export labels for specific codes.
Step-by-step: Export printable labels.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| Current label style and supported formats (Chinese only) | labels/getConfig | Read-only | — |
| Preview labels for specific codes (Chinese only) | labels/preview | Read-only | — |
| Create a label export task (Chinese only) | labelExports/create | Read/write | — |
| Get a label export task and its files (Chinese only) | labelExports/get | Read/write | — |
Recurring plans
Read recurring plans and how each cycle was completed.
| Endpoint | Path | Minimum level | Organization key |
|---|---|---|---|
| List recurring plans (Chinese only) | cyclePlans/list | Read-only | — |
| Get a recurring plan (Chinese only) | cyclePlans/get | Read-only | — |
| Per-code completion for a cycle (Chinese only) | cycleTasks/listQrcodes | Read-only | — |
| Completion of a recurring task (Chinese only) | cycleTasks/getCompletion | Read-only | — |