Skip to content

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.

EndpointPathMinimum levelOrganization key
Current organization, effective permissions and capabilities (Chinese only)auth/getContextRead-onlyYes
Organization quota used today for MCP and API (Chinese only)usage/getRead-onlyYes

Codes ​

List codes and read their content and operation panel.

EndpointPathMinimum levelOrganization key
Get code contentqrcodes/getContentRead-onlyYes
Operation items linked to a codeqrcodes/getOperationRead-onlyYes
List codes (Chinese only)qrcodes/listRead-onlyYes

Batch templates and sub-codes ​

Read batch templates and their sub-codes.

EndpointPathMinimum levelOrganization key
List batch templates (Chinese only)templates/listRead-onlyYes
Get a batch template (Chinese only)templates/getRead-onlyYes
List sub-codes of a template (Chinese only)templates/listQrcodesRead-onlyYes
Get a sub-code (Chinese only)templates/getSubcodeRead-onlyYes

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.

EndpointPathMinimum levelOrganization key
Get form structureforms/getTemplateRead-onlyYes
Get a recordrecord/getRecordRead-onlyYes
List recordsrecord/getRecordsRead-onlyYes
List formsrecord/getFormListRead-onlyYes
Add a recordrecord/addRecordRead/writeYes
Verify a certificatecertificates/verifyRead/writeYes
Follow-up activity on a record (Chinese only)record/getActivitiesRead-only—
Search records for drill-down (Chinese only)record/searchRecordsRead-onlyYes

Projects ​

List the projects in the organization.

EndpointPathMinimum levelOrganization key
List projects (Chinese only)projects/listRead-onlyYes

Metrics ​

Read metric definitions and query results by dimension.

EndpointPathMinimum levelOrganization key
Business objects and available metrics (Chinese only)metrics/listRead-onlyYes
Get a metric definition (Chinese only)metrics/getRead-onlyYes
Query a metric (Chinese only)metrics/queryRead-onlyYes

Official templates ​

Browse the official template library and create one code or a batch from a template.

EndpointPathMinimum levelOrganization key
Official template categories (Chinese only)gallery/categoriesRead-only—
Browse or search official templates (Chinese only)gallery/listRead-only—
Get an official template (Chinese only)gallery/getRead-only—
Prepare an official-template creation plan (Chinese only)gallery/prepare-creationRead/write—
Create one code from an official template (Chinese only)gallery/create-qrcodeRead/write—
Run an official-template creation plan (Chinese only)gallery/create-from-planRead/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.

EndpointPathMinimum levelOrganization key
Prevalidate a batch without creating codes (Chinese only)qrcodes/prevalidateRead/write—
Submit a batch creation task (Chinese only)qrcodes/createBatchRead/write—
Get creation task progress (Chinese only)qrcodeTasks/getRead/write—
Projects and folders you can create in (Chinese only)qrcodes/listCreateTargetsRead-only—
Per-item results of a batch task (Chinese only)qrcodeTasks/getResultsRead/write—
Create a standard code and link forms (Chinese only)qrcodes/createRead/write—
Create a redirect code (Chinese only)qrcodes/createUrlJumpRead/write—
Create a multi-link code (Chinese only)qrcodes/createMultiUrlRead/write—
Create a static text or URL code (Chinese only)staticQrcodes/createRead/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.

EndpointPathMinimum levelOrganization key
Code content, version and editability (Chinese only)qrcodes/getEditStateRead/write—
Edit a standard code (Chinese only)qrcodes/editRead/write—
Edit a redirect code (Chinese only)qrcodes/editUrlJumpRead/write—
Edit a multi-link code (Chinese only)qrcodes/editMultiUrlRead/write—
Edit one sub-code (Chinese only)qrcodeChildren/editRead/write—
Form fields, version and editability (Chinese only)forms/getEditStateRead/write—
Edit a form's name or fields (Chinese only)forms/editRead/write—
Preview code deletion and get a token (Chinese only)qrcodes/previewDeleteFull—
Delete codes with a confirmation token (Chinese only)qrcodes/deleteFull—
Preview form deletion and get a token (Chinese only)forms/previewDeleteFull—
Delete forms with a confirmation token (Chinese only)forms/deleteFull—

Template and form management ​

Find, create and edit templates, and create forms.

EndpointPathMinimum levelOrganization key
Find templates you can create from or edit (Chinese only)templates/listEditableRead-only—
Template fields and version for writing (Chinese only)templates/getSchemaRead-only—
Create a template (Chinese only)templates/createRead/write—
Preview a template change and its impact (Chinese only)templates/previewEditRead/write—
Save template changes (Chinese only)templates/editRead/write—
Create a form, optionally with a schedule (Chinese only)forms/createRead/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.

EndpointPathMinimum levelOrganization key
Request a temporary upload (Chinese only)assets/requestUploadRead/write—
Get upload status (Chinese only)assets/getUploadRead/write—

Labels ​

Read the label style, then preview and export labels for specific codes.

Step-by-step: Export printable labels.

EndpointPathMinimum levelOrganization key
Current label style and supported formats (Chinese only)labels/getConfigRead-only—
Preview labels for specific codes (Chinese only)labels/previewRead-only—
Create a label export task (Chinese only)labelExports/createRead/write—
Get a label export task and its files (Chinese only)labelExports/getRead/write—

Recurring plans ​

Read recurring plans and how each cycle was completed.

EndpointPathMinimum levelOrganization key
List recurring plans (Chinese only)cyclePlans/listRead-only—
Get a recurring plan (Chinese only)cyclePlans/getRead-only—
Per-code completion for a cycle (Chinese only)cycleTasks/listQrcodesRead-only—
Completion of a recurring task (Chinese only)cycleTasks/getCompletionRead-only—