Zapier makes it easy to sync data between different web apps, so you don't have to code to connect Checkvist with other tools, like Evernote or Asana.
Checkvist provides Open API which can be used for integration with other tools. The API offers only limited functionality, though allows both read and write operations. If you have questions regarding OpenAPI, feel free to join Checkvist OpenAPI group.
To emulate HTTP request methods like
DELETE, you can use
POST method and pass
_method with the required method name.
For XML response, the main part of the URL shall end with
.xml suffix. For example:
For JSON response, the corresponding request should end with
If your HTTP client can handle basic HTTP authentication, you can use it to identify the user working with Checkvist API. As a password, you can use either real password of the user, or user can use Remote API key obtained from user profile page.
As a better approach, you can use a token-based authentication.
In this case, you should obtain a token first, and than pass it to all API calls either
token parameter, or in
X-Client-Token HTTP header.
The token is valid only within a limited period of time (1 day).
After that, within 90 days, the token can be refreshed with a special
Old token is deleted after that, and the new one returned.
To obtain the token, you should use the following API call:
Returns a JSON object with the |
Ahd here is the refresh_token call, which allows to get the new token without providing username/remote_key.
Returns a JSON object with the |
If user has 2-step verification enabled,
API calls for obtaining the token should use Remote API key.
Otherwise they should also contain 2-factor authentication
code from the authentication app as the parameter
To obtain information about the current user, use the following API call:
|Returns currently logged-in user JSON/XML data in the body.|
See checklist data fields.
For XML request:
<checklists> <checklist1> <checklist2> <checklistN> </checklists>
|JSON/XML representation for the checklist with given ID. See checklist data fields.|
|JSON/XML representation for the created checklist. See checklist data fields.|
|Update checklist name/public status. Returns JSON/XML representation for the updated checklist. See checklist data fields.|
|Delete the checklist (with all its data). Returns JSON/XML representation for the deleted checklist. See checklist data fields. Actually, at the moment of the call, the list is marked for deletion only. Actual data deletion occurs later, once a day.|
List of representations for the list items of checklist with given ID.
List items are sorted by |
List of XML/JSON representations for the given task and its parents.
Original list item is the first, and than go parents, one after another, till the root parent task.
<tasks> <task> <task_parent> <task_parent_parent> <task_root_parent> </tasks>
|JSON/XML representation for the created task.|
Created list items, organized to hierarchy according to input data. |
List items are added to the beginning of the target list.
|Updates the task information and returns JSON/XML representation for it. This method won't change task status.|
The following actions allow to change task status. You can
Available status change actions are
invalidate(in Checkvist UI, such tasks are marked with italics)
These actions are presented in the final part of action URL below, like
The performed action corresponds to the action name.
Updates the task status and returns representation for it and for its children.
|Sets the repeating task information and returns the updated task.|
|Deletes the list item including its children and returns the deleted list item representation.|
|Get list of existing notes for the task with id task_id. Data format is similar to the case, when notes are included into the task data.|
|Creates a new note for the task with id task_id and returns created note|
|Updates note text for a note with id note_id and returns created note|
|Delete a note with id note_id and returns deleted note|
JSON and XML representations of a checklist have the following fields:
<checklist> <id>1</id> <name>EAP checklist</name> <public>false</public> <role>1</role> <updated_at>2009-05-16T11:20:31Z</updated_at> <task_count>3</task_count> <task_completed>1</task_completed> <read_only>true</read_only> </checklist>
true). In other cases information about deleted tasks is not included to results.
with_notesparameter is set to "true", this field contains a list of notes added to this task. The list of fields for each note is described below. For XML, there is a node
<node>. For JSON, property
<task> <content>Root task</content> <id>3</id> <checklist_id>1</checklist_id> <comments_count>0</comments_count> <parent_id nil="true"></parent_id> <position>3</position> <status>0</status> <notes type="array"/> </task>
<note type="Comment"> <comment>some note1</comment> <created_at>2009-06-12T19:50:00Z</created_at> <id>53</id> <task_id>4</task_id> <updated_at>2009-06-12T19:50:00Z</updated_at> <user_id>123</user_id> <username>kir</username> </note>