REST API Documentation

Zephyr Project Manager includes multiple REST API endpoints documented below and the endpoints are used as shown below:

https://example/wp-json/zephyr_project_manager/v1/<endpoint>

For example:

https://example/wp-json/zephyr_project_manager/v1/tasks

The available endpoints with their arguments and parameters are documented below:

Getting tasks: /tasks

Creating tasks: /tasks/create

Updating tasks: /tasks/update

Deleting task: /tasks/delete

Copying task: /tasks/copy

Converting task to project: /tasks/convert

Marking task as complete/incomplete: /tasks/complete

Getting task subtasks: /tasks/subtasks

Creating subtasks: /tasks/subtasks/create

Getting task discussion messages: /tasks/discussion

Sending task messages: /tasks/message

Getting all projects: /projects

Creating project: /projects/create

Updating project: /projects/update

Updating project status: /projects/update_status

Deleting a project: /projects/delete

Copying a project: /projects/copy

Getting all dashboard projects: /projects/dashboard

Getting all project tasks: /projects/tasks

Getting project discussion: /projects/discussion

Adding a project to the dashboard: /projects/add_to_dashboard

Getting project meta: /projects/get_meta

Updating project meta: /projects/update_meta

Deleting project meta: /projects/delete_meta

Uploading files: /files/upload

Getting all teams: /teams

Getting all users: /users

Getting settings: /settings

Authenticating a user: /authenticate

Getting user permissions: /permissions

Getting all categories: /categories

Creating category: /categories/create

Updating category: /categories/update

Deleting category: /categories/delete

Getting all available statuses: /statuses

PRO endpoints:

Getting all custom fields: /custom_fields

Creating custom fields: /custom_fields/create

Updating custom fields: /custom_fields/update

Deleting custom fields: /custom_fields/delete

Getting all milestones: /milestones

Getting all task templates: /templates

Getting all template custom fields: /templates/custom_fields