Skip to Content
Project Management API

Project Management API

The Project Management API allows you to manage projects, board containers (columns), tasks, labels, assignees, comments, files, discussions and project attributes in your TaskIP workspace.

Conventions

  • Base path: all endpoints live under /api/public-v1. Send your key in the X-Secret-Key header.
  • Project identifier: {uuid} in a path is the project UUID (for example 8f6c2d1e-5b7a-4c0e-9a31-2d4b6e8f0a17). Task {id} is the numeric task id.
  • Enums are integers: project and task priority is 0 Low, 1 Medium, 2 High, 3 Urgent. Project status is 0 Draft, 1 Pinned, 2 Working, 3 Complete, 4 Archived, 5 Review. Project privacy is 0 Private, 1 Public. Project attribute type is 0 Priority, 1 Label, 2 Category, 3 Tag, 4 Status.
  • Containers and tasks: every project has board containers (columns) with a stage category (backlog, todo, in_progress, review, done). A task’s status and completion state follow the container it sits in.
  • Pagination: list endpoints take item (page size, default 10) and page, and return data, links and meta.
  • Errors: see Error Responses for the response shapes.

Complete Endpoints Overview

Project Management

MethodEndpointDescription
GET/api/public-v1/projectGet all projects
POST/api/public-v1/projectCreate a new project
GET/api/public-v1/project/{uuid}Get a specific project
PUT / PATCH/api/public-v1/project/{uuid}Update a project (partial body)
DELETE/api/public-v1/project/{uuid}Delete a project
POST/api/public-v1/project/dashboard/activityGet dashboard activities
POST/api/public-v1/project/{uuid}/activityGet project activities
POST/api/public-v1/project/all-tasks/listGet your tasks across all projects, grouped by due state
POST/api/public-v1/project/{uuid}/change-priorityChange project priority
POST/api/public-v1/project/{uuid}/change-statusChange project status
POST/api/public-v1/project/{uuid}/change-categoryChange project category

Task Management

MethodEndpointDescription
GET/api/public-v1/project/{uuid}/taskGet the project board (containers with their tasks)
POST/api/public-v1/project/{uuid}/taskCreate a new task
GET/api/public-v1/project/{uuid}/task/{id}Get a specific task
PUT/api/public-v1/project/{uuid}/task/{id}Update a task
DELETE/api/public-v1/project/{uuid}/task/{id}Delete a task
POST/api/public-v1/project/{uuid}/task/change-orderChange task order
POST/api/public-v1/project/{uuid}/task/{id}/change-containerChange task container
POST/api/public-v1/project/{uuid}/task/{id}/change-priorityChange task priority
POST/api/public-v1/project/{uuid}/task/{id}/mark-as-completeMark task as complete

Task Labels & Assignees

MethodEndpointDescription
POST/api/public-v1/project/{uuid}/task/{id}/labelAdd label to task
DELETE/api/public-v1/project/{uuid}/task/{id}/labelRemove label from task
POST/api/public-v1/project/{uuid}/task/{id}/assigneeAdd assignee to task
DELETE/api/public-v1/project/{uuid}/task/{id}/assigneeRemove assignee from task

Task Documents & Comments

MethodEndpointDescription
GET/api/public-v1/project/{uuid}/task/{id}/documentGet task documents
POST/api/public-v1/project/{uuid}/task/{id}/documentAdd document to task
DELETE/api/public-v1/project/{uuid}/task/{id}/documentRemove document from task
GET/api/public-v1/project/{uuid}/task/{id}/commentGet task comments
POST/api/public-v1/project/{uuid}/task/{id}/commentAdd comment to task
DELETE/api/public-v1/project/{uuid}/task/{id}/commentRemove comment from task

Task Files Management

MethodEndpointDescription
GET/api/public-v1/project/{uuid}/task/filesGet all task files in project
GET/api/public-v1/project/{uuid}/task/{id}/filesGet task files
POST/api/public-v1/project/{uuid}/task/{id}/filesUpload file to task
DELETE/api/public-v1/project/{uuid}/task/{id}/filesDelete file from task
GET/api/public-v1/project/{uuid}/filesGet all project files

Discussion Management

MethodEndpointDescription
GET/api/public-v1/project/{uuid}/discussionGet project discussions
POST/api/public-v1/project/{uuid}/discussionCreate new discussion
GET/api/public-v1/project/{uuid}/discussion/filesGet discussion files

Container Management (Kanban/Board)

MethodEndpointDescription
POST/api/public-v1/project/{uuid}/containerCreate new container
PUT/api/public-v1/project/{uuid}/container/{id}/renameRename container
POST/api/public-v1/project/{uuid}/container/{id}/change-colorChange container color
POST/api/public-v1/project/{uuid}/container/change-orderChange container order
DELETE/api/public-v1/project/{uuid}/container/{id}/deleteDelete container
POST/api/public-v1/project/{uuid}/container/{id}/move-all-tasksMove all tasks from container

Project Attributes

MethodEndpointDescription
GET/api/public-v1/project/attribute/allGet all project attributes
POST/api/public-v1/project/attributeCreate new attribute
PUT/api/public-v1/project/attribute/{id}/updateUpdate attribute
DELETE/api/public-v1/project/attribute/{id}/deleteDelete attribute
POST/api/public-v1/project/attribute/tags/updateBulk update tags
POST/api/public-v1/project/attribute/categories/updateBulk update categories

Get All Projects

Retrieve a paginated list of the projects the API user can see. Administrators and managers see every project; any other user only sees projects they are a member of. A client user additionally never sees a disabled project.

By default, projects with status 3 (Complete) are left out of the list. Pass status=3 explicitly to list them.

GET /api/public-v1/project

Request Headers

X-Secret-Key: your-secret-key-here Content-Type: application/json

Query Parameters

ParameterTypeRequiredDescription
itemintegerNoProjects per page (default: 10). 0 returns every project in one response without pagination (data only, no links/meta)
pageintegerNoPage number
searchstringNoMatches the project title (partial match)
statusintegerNoFilter by status: 0 Draft, 1 Pinned, 2 Working, 3 Complete, 4 Archived, 5 Review
priorityintegerNoFilter by priority: 0 Low, 1 Medium, 2 High, 3 Urgent
tagintegerNoOnly projects carrying this tag attribute id
client_onlyanyNoWhen present, only projects that have a client are returned
health_bandstring or arrayNoFilter by health band (on_track, at_risk, off_track); repeat the parameter (health_band[]=at_risk) for several
program_idinteger or noneNoOnly projects in this program; none returns projects without a program
sortstringNotitle, due (end date), status, updated, or health. Without sort, newest projects (highest id) come first
dirstringNoasc (default) or desc. Applies to title, due, status and updated

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project?item=20&status=2&sort=updated&dir=desc" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json"

Example Response

{ "data": [ { "id": 12, "title": "Website Redesign - Acme Corp", "uuid": "8f6c2d1e-5b7a-4c0e-9a31-2d4b6e8f0a17", "key": "WEB", "contact_id": 15, "client_id": null, "description": "Complete website redesign and development for Acme Corporation", "priority": 2, "privacy": 1, "status": 2, "is_disabled": 0, "allow_manual_time_tracking": true, "show_time_details_to_client": true, "allow_team_member_task_create": true, "allow_client_task_create": true, "task_move_access": "own", "task_status_access": "own", "task_priority_access": "managers", "stage_categories_confirmed_at": null, "default_client_visible": true, "client_intake_enabled": true, "client_intake_types": null, "allows_client_intake": true, "budget_hours": 120.0, "budget_amount": null, "budget_cap_mode": "hard", "budget_overrun_percent": null, "budget_alert_thresholds": [], "contract_value": null, "started_at": "2024-01-15", "ended_at": "2024-04-15", "client": [ { "id": 28, "uuid": "0b1c9d2e-7f43-4a55-8e12-6c3d5a7b9e01", "first_name": "John", "last_name": "Smith", "full_name": "John Smith", "email": "john@acmecorp.com", "timezone": "America/New_York", "image": null } ], "created_by": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "first_name": "Sarah", "last_name": "Johnson", "full_name": "Sarah Johnson", "email": "sarah@company.com", "timezone": "UTC", "image": null }, "created_at": "2024-01-10", "updated_at": "2024-01-20", "project_manager": { "id": 5, "uuid": "9d3f5b7a-1c64-4e82-b6a0-4e6a8c0e2f05", "first_name": "Mike", "last_name": "Wilson", "full_name": "Mike Wilson", "email": "mike@company.com", "timezone": "UTC", "image": null }, "assignees": [ { "id": 8, "uuid": "2e4a6c8e-0b75-4d91-8c23-7a9b1d3f5e08", "first_name": "David", "last_name": "Chen", "full_name": "David Chen", "email": "david@company.com", "timezone": "UTC", "image": null } ], "tags": [ { "id": 4, "title": "website", "color": "orange", "type": 3 } ], "categories": [ { "id": 9, "title": "Development", "color": "green", "type": 2 } ], "total_tasks": 45, "completed_tasks": 29, "completion_percentage": 64.44, "members": [ { "user": { "id": 5, "uuid": "9d3f5b7a-1c64-4e82-b6a0-4e6a8c0e2f05", "first_name": "Mike", "last_name": "Wilson", "full_name": "Mike Wilson", "email": "mike@company.com", "timezone": "UTC", "image": null }, "role": "lead", "role_label": "Lead", "workspace_role": 2, "added_by": 3, "via_company": null, "created_at": "2024-01-10T09:30:00+00:00", "is_you": false } ], "my_role": "lead", "leads": [ { "id": 5, "uuid": "9d3f5b7a-1c64-4e82-b6a0-4e6a8c0e2f05", "first_name": "Mike", "last_name": "Wilson", "full_name": "Mike Wilson", "email": "mike@company.com", "timezone": "UTC", "image": null } ], "auto_shift_dependents": false, "next_milestone": null, "methodology": "kanban", "estimate_unit": "hours", "active_sprint_uuid": null, "health": null, "program": null, "template_uuid": null, "template_name": null } ], "links": { "first": "https://public-api.taskip.net/api/public-v1/project?page=1", "last": "https://public-api.taskip.net/api/public-v1/project?page=3", "prev": null, "next": "https://public-api.taskip.net/api/public-v1/project?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 3, "path": "https://public-api.taskip.net/api/public-v1/project", "per_page": 20, "to": 20, "total": 45 } }

Response Notes

  • priority, privacy and status are returned as integers (see the enum tables under Create New Project).
  • client, project_manager and assignees are deprecated, derived from members; prefer members and leads. project_manager is a single user object (the earliest lead), or [] when the project has no lead.
  • budget_* keys are omitted entirely for a client user. contract_value is omitted unless the API user has permission to view project rates.
  • health is { "score", "band", "computed_at" } when a health band has been computed, otherwise null. program is { "id", "uuid", "name", "color" } or null.
  • tags and categories items come from project attributes: type is 3 for tags and 2 for categories.

Create New Project

Create a new project. The API user becomes the creator (created_by); a created_by value in the body is ignored. Five default board containers are created for every project (Backlog, To Do, In Progress, Review, Done).

POST /api/public-v1/project

Request Body

FieldTypeRequiredDescription
titlestringYesProject title (max 191 characters)
priorityintegerYes0 Low, 1 Medium, 2 High, 3 Urgent
privacyintegerYes0 Private, 1 Public
statusintegerYes0 Draft, 1 Pinned, 2 Working, 3 Complete, 4 Archived, 5 Review
descriptionstringNoProject description
started_atstringNoStart date, e.g. 2024-03-01
ended_atstringNoEnd date, e.g. 2024-09-01
keystringNoShort project key (2-10 uppercase letters or digits, starting with a letter). Must be unique; derived from the title when omitted
tagsarrayNoTag attribute ids (type 3)
categoryarrayNoCategory attribute ids (type 2)
membersarrayNoProject members: [{ "user_id": 8, "role": "member" }]. role is one of lead, member, viewer, client. When sent, it takes precedence over the legacy client, assignee and project_manager fields
clientarrayNoLegacy: client user ids (become client members)
assigneearrayNoLegacy: team member user ids (become member members)
project_managerintegerNoLegacy: a single user id (becomes lead)
notify_clientbooleanNoSend a notification email to the client (default false)
allow_manual_time_trackingbooleanNoDefault true
show_time_details_to_clientbooleanNoDefault true
allow_team_member_task_createbooleanNoDefault true
allow_client_task_createbooleanNoDefaults to the value of client_intake_enabled (true when that is omitted)
task_move_accessstringNomanagers, own or all
task_status_accessstringNomanagers, own or all
task_priority_accessstringNomanagers, own or all
billing_typestringNohourly, fixed_price, retainer, non_billable or internal
default_billablebooleanNoWhether new time entries are billable by default
billable_ratenumberNoMin 0
cost_ratenumberNoMin 0
currencystringNo3-letter currency code, e.g. USD
billing_profile_idintegerNoMust exist in billing profiles
budget_hoursnumberNoHours cap, 0.01 to 99999999.99. null means no cap
budget_amountnumberNoAmount cap, 0.01 to 999999999999.99. null means no cap
budget_cap_modestringNohard, overrun_limited or warn_only. Must be a mode the workspace policy allows
budget_overrun_percentnumberNoGreater than 0, max 100. Required when the mode is overrun_limited and no default is configured
budget_alert_thresholdsarrayNoUp to 10 integers between 1 and 100
contract_valuenumberNoPlanned revenue (0.01 to 999999999999.99). Refused with a validation error unless the API user may view project rates
show_financials_to_clientbooleanNoSame permission rule as contract_value
default_client_visiblebooleanNoDefault true
client_intake_enabledbooleanNoDefault true
client_intake_typesarrayNoOne or more of feedback, bug, change_request
auto_shift_dependentsbooleanNoDefault false
methodologystringNokanban or scrum
estimate_unitstringNohours or points
client_voting_enabledbooleanNoDefault false
show_health_to_clientbooleanNoDefault false

Enum Reference

FieldValues
priority0 Low, 1 Medium, 2 High, 3 Urgent
privacy0 Private, 1 Public
status0 Draft, 1 Pinned, 2 Working, 3 Complete, 4 Archived, 5 Review

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "title": "E-commerce Platform", "description": "Build complete e-commerce platform", "priority": 2, "privacy": 1, "status": 2, "started_at": "2024-03-01", "ended_at": "2024-09-01", "tags": [4, 6], "category": [9], "members": [ { "user_id": 5, "role": "lead" }, { "user_id": 8, "role": "member" }, { "user_id": 28, "role": "client" } ], "notify_client": true, "budget_hours": 400 }'

Example Response

The response is a ProjectResource (same shape as one item of the list). Task counters are not computed on create, so total_tasks and completed_tasks are null.

{ "msg": "Project Created Successfully", "data": { "id": 26, "title": "E-commerce Platform", "uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "key": "ECOM", "contact_id": 31, "client_id": null, "description": "Build complete e-commerce platform", "priority": 2, "privacy": 1, "status": 2, "is_disabled": 0, "budget_hours": 400.0, "budget_amount": null, "budget_cap_mode": "hard", "started_at": "2024-03-01", "ended_at": "2024-09-01", "tags": [ { "id": 4, "title": "website", "color": "orange", "type": 3 }, { "id": 6, "title": "platform", "color": "blue", "type": 3 } ], "categories": [ { "id": 9, "title": "Development", "color": "green", "type": 2 } ], "total_tasks": null, "completed_tasks": null, "completion_percentage": 0, "my_role": null, "methodology": "kanban", "estimate_unit": "hours" } }

The example above is abbreviated; the full object contains every key shown in Get All Projects.

Error Responses

Validation failure (HTTP 422):

{ "error": { "title": ["The title field is required."], "priority": ["The selected priority is invalid."] } }

Permission refusal (HTTP 422), when the API user is not allowed to create projects:

{ "error": { "msg": ["You don't have permission to create project"] } }

Business-rule failure (HTTP 422), for example a member role that is not valid for that user:

{ "msg": "<reason>" }

Get Specific Project

Retrieve a single project by its UUID. Returns 404 when the project does not exist or the API user is not allowed to see it (non-admin users must be a member of the project).

GET /api/public-v1/project/{uuid}

Path Parameters

ParameterTypeDescription
uuidstringProject UUID

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/8f6c2d1e-5b7a-4c0e-9a31-2d4b6e8f0a17" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

The single-project resource contains everything the list item has, plus billing, finance and planning details.

{ "data": { "id": 12, "title": "Website Redesign - Acme Corp", "uuid": "8f6c2d1e-5b7a-4c0e-9a31-2d4b6e8f0a17", "key": "WEB", "contact_id": 15, "description": "Complete website redesign and development for Acme Corporation", "priority": 2, "privacy": 1, "status": 2, "is_disabled": 0, "task_move_access": "own", "task_status_access": "own", "task_priority_access": "managers", "billing_type": "fixed_price", "default_billable": true, "billable_rate": 75.0, "cost_rate": 40.0, "currency": "USD", "billing_profile_id": null, "budget_hours": 120.0, "budget_amount": null, "budget_cap_mode": "hard", "budget_overrun_percent": null, "budget_alert_thresholds": [], "budget_policy": { "allowed_cap_modes": ["hard", "overrun_limited", "warn_only"], "default_overrun_percent": 10.0, "can_change_caps": true }, "can_view_finance": true, "contract_value": 15000.0, "started_at": "2024-01-15", "ended_at": "2024-04-15", "client_id": null, "client": [], "created_by": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "first_name": "Sarah", "last_name": "Johnson", "full_name": "Sarah Johnson", "email": "sarah@company.com", "timezone": "UTC", "image": null }, "created_at": "15-Jan-2024", "updated_at": "15-Jan-2024", "assignees": [], "tags": [{ "id": 4, "title": "website", "color": "orange", "type": 3 }], "categories": [{ "id": 9, "title": "Development", "color": "green", "type": 2 }], "project_manager": [], "complete_status_id": 87, "total_tasks": 45, "completed_tasks": 29, "completion_percentage": 64.44, "short_description": "Complete website redesign and development for Acme Corporation", "members": [], "my_role": "lead", "leads": [], "custom_fields": [], "auto_shift_dependents": false, "next_milestone": { "id": 3, "title": "Design sign-off", "due_date": "2024-02-15", "percent": 50 }, "methodology": "kanban", "estimate_unit": "hours", "active_sprint_uuid": null, "show_health_to_client": false, "show_financials_to_client": false, "program": null, "health": { "score": 82, "band": "on_track", "computed_at": "2024-01-20T06:00:00+00:00", "factors": [] }, "template_uuid": null, "template_name": null }, "status": 200 }

members, leads, client, assignees and project_manager use the same shapes as in Get All Projects (they are empty in the example above only to keep it short). complete_status_id is deprecated.

created_at and updated_at are the real timestamps of the project record (formatted d-M-Y), independent of started_at. The same applies to the data object returned by Update Project.

Error Responses

Project not found (HTTP 404):

{ "msg": "Project not found" }

Update Project

Update a project. The body is partial: only the keys you send are written; anything you omit is left untouched.

  • tags, category and members (or the legacy client, assignee, project_manager) replace the existing relation when sent. Sending "tags": [] clears all tags.
  • Sending null for budget_hours, budget_amount or contract_value removes that cap/value.
  • task_move_access, task_status_access and task_priority_access fall back to their defaults (own, own, managers) if sent as null.
PUT /api/public-v1/project/{uuid} PATCH /api/public-v1/project/{uuid}

Path Parameters

ParameterTypeDescription
uuidstringProject UUID (a numeric project id is also accepted)

Request Body

Any of the fields from Create New Project, all optional on update. If a field is sent, the create-time validation rules still apply to it (for example title cannot be empty and priority must be 0-3). key cannot be changed through this endpoint.

FieldTypeRequiredDescription
titlestringNoMax 191 characters; cannot be null when sent
descriptionstringNoMay be null
priorityintegerNo0-3
privacyintegerNo0 or 1
statusintegerNo0-5
started_at / ended_atstringNoMay be null
tagsarrayNoReplaces the project’s tags
categoryarrayNoReplaces the project’s categories
membersarrayNoReplaces the project’s members ([{ "user_id", "role" }])
budget_hours / budget_amountnumberNonull removes the cap
methodologystringNokanban or scrum. Switching a scrum project with an active sprint to kanban is refused

Example Request

curl -X PUT "https://public-api.taskip.net/api/public-v1/project/8f6c2d1e-5b7a-4c0e-9a31-2d4b6e8f0a17" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "status": 5, "ended_at": "2024-05-01", "tags": [4, 7], "budget_amount": null }'

Example Response

{ "msg": "Project Updated", "status": 200, "data": { "id": 12, "title": "Website Redesign - Acme Corp", "uuid": "8f6c2d1e-5b7a-4c0e-9a31-2d4b6e8f0a17", "priority": 2, "privacy": 1, "status": 5, "ended_at": "2024-05-01", "budget_amount": null, "tags": [ { "id": 4, "title": "website", "color": "orange", "type": 3 }, { "id": 7, "title": "priority-client", "color": "red", "type": 3 } ] } }

The data object is the full single-project resource described in Get Specific Project; it is abbreviated here.

Error Responses

Project not found (HTTP 404):

{ "msg": "Project not found" }

Validation failure (HTTP 422):

{ "error": { "status": ["The selected status is invalid."] } }

Business-rule failure (HTTP 422), for example an invalid member role, or Finish the active sprint before switching to Kanban. when changing methodology:

{ "msg": "Finish the active sprint before switching to Kanban." }

Permission refusal (HTTP 422). The project role checks are defined in the platform, but they are bypassed for requests made with an API key to /api/public-v1, so you are not expected to receive this response from the public API:

{ "error": { "msg": ["You don't have permission to update project"] } }

Delete Project

Delete a project. Only an administrator or the project’s lead may delete it (subject to the role’s delete scope). Disabled projects are treated as not found.

DELETE /api/public-v1/project/{uuid}

Path Parameters

ParameterTypeDescription
uuidstringProject UUID (a numeric project id is also accepted)

Example Request

curl -X DELETE "https://public-api.taskip.net/api/public-v1/project/8f6c2d1e-5b7a-4c0e-9a31-2d4b6e8f0a17" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "msg": "Project Deleted", "status": 200 }

Error Responses

Not found (HTTP 404):

{ "msg": "We couldn't find this project. It may have been deleted or you may no longer have access to it." }

Permission refusal (HTTP 422). The permission is checked for the API key’s user before anything is logged or deleted:

{ "error": { "msg": ["You don't have permission to delete this project."] } }

Get Dashboard Activities

Get the legacy activity feed across the projects the API user can access. A client user only sees activity for projects where they are the client; administrators see everything; any other user only sees activity for projects they are a member of. Newest activity comes first.

This endpoint is a POST, but it takes no required body. The paging parameters below can be sent in the query string or the JSON body.

POST /api/public-v1/project/dashboard/activity

Parameters

FieldTypeRequiredDescription
itemintegerNoActivities per page (default: 10). 0 returns all activities without pagination
pageintegerNoPage number
searchstringNoEchoed back in meta.search; it does not filter the results on this endpoint

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/dashboard/activity?item=20" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json"

Example Response

{ "data": [ { "id": 981, "project_uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "activity_type": "task_created", "content": "New task created: Design database schema", "metadata": { "task_id": 245, "task_title": "Design database schema" }, "old_value": null, "new_value": null, "task": null, "createdBy": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "first_name": "Sarah", "last_name": "Johnson", "full_name": "Sarah Johnson", "email": "sarah@company.com", "timezone": "UTC", "image": null }, "updatedBy": null, "project": { "id": 26, "title": "E-commerce Platform", "uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "status": 2, "priority": 2 }, "createdAt": "2 hours ago" } ], "links": { "first": "https://public-api.taskip.net/api/public-v1/project/dashboard/activity?page=1", "last": "https://public-api.taskip.net/api/public-v1/project/dashboard/activity?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "https://public-api.taskip.net/api/public-v1/project/dashboard/activity", "per_page": 10, "to": 1, "total": 1 } }

project is the full project resource described in Get All Projects (abbreviated above). createdBy / updatedBy use the user shape from that section and can be null.


Get Project Activities

Get the paginated activity feed of one project, newest first. Despite being a POST, the endpoint takes no required body; all parameters are optional and can be sent in the query string or JSON body.

POST /api/public-v1/project/{uuid}/activity

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Parameters

FieldTypeRequiredDescription
itemintegerNoActivities per page (default: 10, maximum: 100)
pageintegerNoPage number
searchstringNoMatches the activity text or the actor’s name/email
categorystringNoExact activity category string, as returned in type.category (for example Project Operations, Project Attributes, Task Operations, Task Comments, Containers)

Finance-related activity lines are hidden from users who may not view project money.

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/activity?item=20&category=Task%20Operations" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "data": [ { "id": 5120, "task": "Task 'Design database schema' was created.", "description": "A new task has been added to the project.", "type": { "value": 20, "label": "Task created", "category": "Task Operations" }, "status": 1, "metadata": { "task_id": 245, "task_title": "Design database schema", "priority": 2, "status": 0 }, "related_entity": { "id": 245, "type": "Modules\\Project\\Models\\ProjectTask" }, "user": { "id": 3, "full_name": "Sarah Johnson", "email": "sarah@company.com" }, "project": { "uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "title": "E-commerce Platform" }, "created_at": "2024-03-04T10:15:00+00:00", "created_at_human": "2 hours ago", "updated_at": "2024-03-04T10:15:00+00:00" } ], "links": { "first": "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/activity?page=1", "last": "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/activity?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/activity", "per_page": 20, "to": 1, "total": 1 } }

Error Responses

Unknown project UUID (HTTP 404):

{ "msg": "Project not found" }

Get All Tasks List

List tasks across all projects, grouped by due state. Only tasks that the API user can see are returned: by default the tasks the user created or is assigned to, narrowed by type.

Results are paginated, and the groups are built from the tasks on the current page. Tasks are grouped as:

GroupMeaning
CompletedTask is completed (or has status 3)
TodayBoth started_at and due_date are set and today falls between them
Upcomingstarted_at is in the future
Overduedue_date has passed
OtherEverything else

Groups with no tasks on the page are not present in data.

POST /api/public-v1/project/all-tasks/list

Request Body

All fields are optional and can be sent in the JSON body or the query string.

FieldTypeRequiredDescription
typeintegerNo1 only tasks created by the API user, 2 only tasks assigned to the API user. Any other value or no value returns tasks that are either created by or assigned to the API user
statusintegerNoTask status: 0 To Do/Backlog, 2 In Progress, 3 Complete, 5 Review
searchstringNoMatches the task title (partial match)
itemintegerNoTasks per page (default: 10, minimum 0)
pageintegerNoPage number

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/all-tasks/list" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "type": 2, "status": 2, "search": "design", "item": 20 }'

Example Response

{ "data": { "Overdue": [ { "id": 245, "number": 12, "key": "ECOM-12", "watchers_count": 2, "is_watching": true, "title": "Design database schema", "project_uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "priority": 2, "is_completed": false, "description": "Create ERD for the platform", "due_date": "2024-03-01", "started_at": "2024-02-20", "order": 3, "container_id": 88, "container_category": "in_progress", "milestone": null, "sprint": null, "story_points": null, "estimate_unit": "hours", "estimate_value": null, "status": 2, "type": "task", "triage_status": "none", "created_at": "20/Feb/2024", "assignees": [ { "task_id": 245, "assignee_id": { "id": 8, "uuid": "2e4a6c8e-0b75-4d91-8c23-7a9b1d3f5e08", "first_name": "David", "last_name": "Chen", "full_name": "David Chen", "email": "david@company.com", "timezone": "UTC", "image": null }, "assigned_by": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "first_name": "Sarah", "last_name": "Johnson", "full_name": "Sarah Johnson", "email": "sarah@company.com", "timezone": "UTC", "image": null }, "created_at": "20/Feb/2024", "id": 311 } ], "labels": [], "updated_at": "28/Feb/2024", "created_by": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "first_name": "Sarah", "last_name": "Johnson", "full_name": "Sarah Johnson", "email": "sarah@company.com", "timezone": "UTC", "image": null }, "client_visible": true, "comments_count": 1, "internal_comments_count": 0, "client_state": "in_progress" } ] }, "links": { "first": "https://public-api.taskip.net/api/public-v1/project/all-tasks/list?page=1", "last": "https://public-api.taskip.net/api/public-v1/project/all-tasks/list?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "url": null, "label": "&laquo; Previous", "active": false }, { "url": "https://public-api.taskip.net/api/public-v1/project/all-tasks/list?page=1", "label": "1", "active": true }, { "url": null, "label": "Next &raquo;", "active": false } ], "path": "https://public-api.taskip.net/api/public-v1/project/all-tasks/list", "per_page": 20, "to": 1, "total": 1 } }

Error Responses

Validation failure (HTTP 422), for example status that is not an integer or a negative item:

{ "success": false, "message": "Validation failed", "errors": { "status": ["The status field must be an integer."] } }

Change Project Priority

Change a project’s priority. priority is required and must be a priority enum value (0 Low, 1 Medium, 2 High, 3 Urgent); anything else is rejected with a validation error before any permission check.

POST /api/public-v1/project/{uuid}/change-priority

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Request Body

FieldTypeRequiredDescription
priorityintegerYes0 Low, 1 Medium, 2 High, 3 Urgent

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/8f6c2d1e-5b7a-4c0e-9a31-2d4b6e8f0a17/change-priority" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "priority": 3 }'

Example Response

The success body is a JSON array containing one message string:

["Project Priority Updated"]

Error Responses

Missing or invalid priority (HTTP 422, standard validation response):

{ "success": false, "message": "Validation failed", "errors": { "priority": ["The selected priority is invalid."] } }

Project not found (HTTP 404):

{ "msg": "We couldn't find this project. It may have been deleted or you may no longer have access to it." }

Permission refusal (HTTP 422), when the workspace edit scope does not allow the API user to change this project:

{ "error": { "msg": ["You don't have permission to change this project's priority."] } }

Change Project Status

Change a project’s status. status is required and must be a status enum value (0-5); anything else is rejected with a validation error before any permission check.

POST /api/public-v1/project/{uuid}/change-status

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Request Body

FieldTypeRequiredDescription
statusintegerYes0 Draft, 1 Pinned, 2 Working, 3 Complete, 4 Archived, 5 Review

Moving a project to 3 (Complete) or 4 (Archived) is subject to the project close-out checklist:

  • If the API user is a workspace administrator, the status is changed directly. If any close-out item is still open, the success array also carries a warning.open_items entry.
  • If the API user is a manager, the project goes through the close-out checklist instead; when items are still open the request is refused with 422 and the list of open items.

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/8f6c2d1e-5b7a-4c0e-9a31-2d4b6e8f0a17/change-status" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "status": 2 }'

Example Response

["Project Status Updated"]

When an administrator completes or archives a project that still has open close-out items, the response also contains a warning key (the array becomes an object with numeric key 0):

{ "0": "Project Status Updated", "warning": { "open_items": [ { "key": "tasks_done", "label": "All tasks done or moved", "description": "No open tasks outside Done or Backlog.", "auto": true, "done": false, "done_by": null, "done_at": null, "note": null, "blockers": null } ] } }

Error Responses

Missing or invalid status (HTTP 422, standard validation response):

{ "success": false, "message": "Validation failed", "errors": { "status": ["The selected status is invalid."] } }

Open close-out items (HTTP 422):

{ "msg": "Some close-out items are still open.", "data": { "open_items": [ { "key": "files_handed_over", "label": "Files handed over", "description": "Deliverables and files have been handed over to the client.", "auto": false, "done": false, "done_by": null, "done_at": null, "note": null, "blockers": null } ] } }

Project not found (HTTP 404):

{ "msg": "We couldn't find this project. It may have been deleted or you may no longer have access to it." }

Permission refusal (HTTP 422):

{ "error": { "msg": ["You don't have permission to change this project's status."] } }

Change Project Category

Replace the categories of a project. The categories you send become the project’s complete category list; categories not in the array are removed.

POST /api/public-v1/project/{uuid}/change-category

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Request Body

FieldTypeRequiredDescription
categoryarray of integersYesCategory attribute ids. Every id must exist in the project attributes (use Get All Attributes with type=2 to list categories)

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/8f6c2d1e-5b7a-4c0e-9a31-2d4b6e8f0a17/change-category" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "category": [9, 11] }'

Example Response

The success body is a JSON array containing one message string:

["Project Category Updated"]

Error Responses

Project not found (HTTP 404):

{ "msg": "We couldn't find this project. It may have been deleted or you may no longer have access to it." }

Validation failure (HTTP 422), for example a missing category or an id that does not exist:

{ "success": false, "message": "Validation failed", "errors": { "category.0": ["The selected category.0 is invalid."] } }

Permission refusal (HTTP 422), when the workspace edit scope does not allow the API user to change this project:

{ "error": { "msg": ["You don't have permission to change this project's category."] } }

Get Project Tasks

Retrieve a project’s board: its containers (columns) in board order, each with its tasks. The result is grouped by container, not a flat task list.

The Backlog container is not included. Tasks that are still awaiting triage (triage_status = pending) are not included. A client user only receives client-visible tasks.

GET /api/public-v1/project/{uuid}/task

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Query Parameters

ParameterTypeRequiredDescription
searchstringNoMatches the task title (partial match). Containers are still returned, with an empty items list when nothing matches
itemintegerNoContainers per page (default: 10). 0 returns every container without pagination
pageintegerNoPage number

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task?search=auth" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "data": [ { "id": "container-89", "container_id": 89, "title": "In Progress", "color": "blue", "order": 2, "category": "in_progress", "is_system": false, "stats": { "total_tasks": 4, "completed_tasks": 0, "completion_percentage": 0 }, "items": [ { "id": 246, "number": 13, "key": "ECOM-13", "title": "Setup authentication", "project_uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "priority": 1, "is_completed": false, "due_date": "2024-03-15", "order": 2, "container_id": 89, "container_category": "in_progress", "status": 2, "type": "task", "assignees": [], "labels": [], "comments_count": 0 } ] } ], "links": { "first": "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task?page=1", "last": "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task", "per_page": 10, "to": 4, "total": 4 } }

Each entry of items is the full task object documented under Create Task (abbreviated above). category is the container’s stage category: backlog, todo, in_progress, review or done.

Error Responses

Project not found (HTTP 404):

{ "msg": "project not found" }

Create Task

Create a new task in a project. The task is placed in the given container and takes its status and completion state from the container’s stage category (a task created in a done container is created completed).

POST /api/public-v1/project/{uuid}/task

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Request Body

FieldTypeRequiredDescription
titlestringYesTask title
container_idinteger or stringYesContainer (column) id of this project. 89 and container-89 are both accepted. A container of another project is rejected with 422
priorityintegerNo0 Low (default), 1 Medium, 2 High, 3 Urgent
descriptionstringNoTask description
started_atstringNoStart date, e.g. 2024-03-01
due_datestringNoDue date. Must be a valid date
orderintegerNoPosition in the container. Omit (or 0) to use the default position
assigneesarrayNoUser ids to assign. Unknown ids are skipped
typestringNotask (default), bug, feature, feedback, change_request
client_visiblebooleanNoWhether clients can see the task. Defaults to the project’s default_client_visible setting
milestone_idintegerNoMust be a milestone of this project, otherwise 422
sprint_idintegerNoMust be a sprint of this project, otherwise 422. Only applied when the project is a scrum project (a kanban project ignores it)
story_pointsnumberNo0 to 999.9
original_estimate_secondsintegerNo0 to 315360000. When only current_estimate_seconds is sent, the original estimate is set to the same value
current_estimate_secondsintegerNo0 to 315360000
custom_fieldsarrayNo[{ "label": "...", "value": "...", "type": "..." }]; all three keys are required in each entry
statusstringNoIgnored on create. The status comes from the container’s stage category
originstringNoHonoured only for administrators/managers: internal, client, public_link, email, ticket, ai, import, workflow. Origins that need triage place the task in the Backlog, unassigned
labels, documentsarrayNoAccepted by validation but not applied on create. Use Add Task Label and Add Task Document after creating the task
recurrenceobjectNoValidated, but not saved by this endpoint

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "title": "Setup authentication", "description": "Implement user authentication system with JWT", "container_id": 89, "priority": 1, "started_at": "2024-03-04", "due_date": "2024-03-15", "assignees": [12], "type": "feature", "current_estimate_seconds": 28800 }'

Example Response

{ "msg": "Task Created", "task": { "id": 246, "number": 13, "key": "ECOM-13", "watchers_count": 1, "is_watching": true, "abilities": { "view": true, "comment": true, "time_log": true, "status": true, "estimate": true, "subtask": true, "define": true, "custom_fields": true, "priority": true, "schedule": true, "stage": true, "assign": true, "duplicate": true, "delete": true, "triage": true, "comment_internal": true, "client_visibility": true, "vote": false }, "title": "Setup authentication", "project_uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "priority": 1, "is_completed": false, "description": "Implement user authentication system with JWT", "due_date": "2024-03-15", "order": 2, "container_id": 89, "container_category": "in_progress", "milestone": null, "sprint": null, "story_points": null, "estimate_unit": "hours", "estimate_value": null, "is_blocked": false, "dependency_counts": { "predecessors": 0, "dependents": 0 }, "type": "feature", "origin": "internal", "triage_status": "none", "resolution": null, "resolved_at": null, "triaged_at": null, "created_at": "2024-03-04", "documents": [], "assignees": [ { "task_id": 246, "assignee_id": { "id": 12, "uuid": "7b9d1f3a-5c20-4e86-a4c8-0e2a4c6e8f12", "first_name": "Lisa", "last_name": "Park", "full_name": "Lisa Park", "email": "lisa@company.com", "timezone": "UTC", "image": null }, "assigned_by": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "first_name": "Sarah", "last_name": "Johnson", "full_name": "Sarah Johnson", "email": "sarah@company.com", "timezone": "UTC", "image": null }, "created_at": "04/Mar/2024", "id": 312 } ], "labels": [], "files": [], "comments": [], "client_visible": true, "comments_count": 0, "internal_comments_count": 0, "client_state": "in_progress", "updated_at": "2024-03-04", "created_by": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "first_name": "Sarah", "last_name": "Johnson", "full_name": "Sarah Johnson", "email": "sarah@company.com", "timezone": "UTC", "image": null }, "status": 2, "started_at": "2024-03-04", "ended_at": null, "name": null, "subtasks": [], "custom_fields": [], "parent_task_id": null, "original_estimate_seconds": 28800, "current_estimate_seconds": 28800, "sla": null, "votes_count": 0, "voted_by_me": false }, "status": 200 }

is_blocked, dependency_counts, sprint, story_points, estimate_*, internal_comments_count and sla are omitted for client users. recurrence is included when the task has recurring settings loaded, and email_source only for email-origin tasks.

Error Responses

Project not found (HTTP 404):

{ "msg": "project not found" }

Validation failure (HTTP 422):

{ "error": { "title": ["The title field is required."], "container_id": ["The board column field is required."] } }

Business-rule failure (HTTP 422), for example a milestone_id that belongs to another project:

{ "msg": "The milestone belongs to another project." }

The same shape is used for a container_id or sprint_id that belongs to another project (The container belongs to another project., The sprint belongs to another project.).


Get Specific Task

Retrieve one task of a project, including its container, files, comments and subtasks.

GET /api/public-v1/project/{uuid}/task/{id}

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "data": { "id": 246, "number": 13, "key": "ECOM-13", "watchers_count": 1, "is_watching": true, "abilities": { "view": true, "comment": true, "delete": true }, "title": "Setup authentication", "project_uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "priority": 1, "is_completed": false, "description": "Implement user authentication system with JWT", "due_date": "2024-03-15", "order": 2, "container": { "id": 89, "project_uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "title": "In Progress", "color": "blue", "order": 2, "category": "in_progress", "is_system": false, "created_at": "04/Mar/2024" }, "milestone": null, "type": "feature", "origin": "internal", "triage_status": "none", "resolution": null, "labels": [ { "id": 31, "task_id": 246, "attribute_id": 14, "attribute": { "color": "red", "title": "Backend", "type": 1 } } ], "files": [], "comments": [], "client_visible": true, "comments_count": 0, "client_state": "in_progress", "documents": [], "assignees": [], "created_at": "2024-03-04", "updated_at": "2024-03-04", "started_at": "2024-03-04", "ended_at": null, "subtasks": [], "custom_fields": [], "original_estimate_seconds": 28800, "current_estimate_seconds": 28800, "sla": null, "votes_count": 0, "voted_by_me": false }, "status": 200 }

This is the single-task shape, abbreviated. It is close to the list/create task object but returns the full container object instead of container_id/container_category. In this response each assignees entry is a plain user-style object; see the note below.

Known quirk: on this endpoint assignees is rendered from the assignment rows with the user transformer, so the entries contain the assignment id in id and null for the name and email fields. Use the assignees of the list, create or update responses (or the assignee endpoints) when you need the member details.

Error Responses

Project or task not found (HTTP 404):

{ "msg": "We couldn't find this task." }
{ "msg": "We couldn't find this project. It may have been deleted or you may no longer have access to it." }

Update Task

Update a task. title and container_id are always required (the container must belong to this project). Every other column is partial: only the keys present in the request are written, so omitting description, due_date, started_at, order, story_points, sprint_id or custom_fields leaves the stored value untouched. Send null to clear a nullable value.

Fields that are only written when sent: priority, status, type, client_visible, milestone_id.

PUT /api/public-v1/project/{uuid}/task/{id}

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

Same fields and rules as Create Task. Differences on update:

FieldBehavior on update
assigneesWhen non-empty, the task’s assignees are synced to exactly this list (missing members are removed). An empty or omitted list leaves assignees unchanged
labelsWhen non-empty, the task’s labels are synced to exactly this list of label attribute ids. An empty or omitted list leaves labels unchanged
documentsWhen non-empty, the task’s documents are synced to exactly this list of document ids. An empty or omitted list leaves documents unchanged
statusWritten as sent
type, priority, client_visible, milestone_idWritten only when sent. origin is never changed
milestone_idMust belong to this project, otherwise 422. It cannot be cleared through this endpoint
sprint_idMust belong to this project, otherwise 422. Only applied when the project is a scrum project (a kanban project ignores it) and only when sent; leaving it out keeps the task’s current sprint

Example Request

curl -X PUT "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "title": "Setup authentication and authorization", "description": "Implement user auth with JWT and role-based access", "container_id": 89, "priority": 2, "started_at": "2024-03-04", "due_date": "2024-03-20", "order": 2, "assignees": [12, 8], "labels": [14] }'

Example Response

{ "msg": "Task Update", "task": { "id": 246, "number": 13, "key": "ECOM-13", "title": "Setup authentication and authorization", "project_uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "priority": 2, "is_completed": false, "description": "Implement user auth with JWT and role-based access", "due_date": "2024-03-20", "order": 2, "container_id": 89, "type": "feature", "labels": [ { "id": 31, "task_id": 246, "attribute_id": 14, "attribute": { "color": "red", "title": "Backend", "type": 1 } } ], "updated_at": "2024-03-06" }, "status": 200 }

task is the full task object described under Create Task (abbreviated here).

Error Responses

Project or task not found (HTTP 404):

{ "msg": "project not found" }
{ "msg": "task not found" }

Validation failure (HTTP 422) uses { "error": { "field": ["..."] } }. A business-rule failure such as a milestone, container or sprint from another project returns HTTP 422:

{ "msg": "The container belongs to another project." }

Other messages of the same shape: The milestone belongs to another project. and The sprint belongs to another project..


Delete Task

Delete a task. A task that has tracked time entries cannot be deleted.

DELETE /api/public-v1/project/{uuid}/task/{id}

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Example Request

curl -X DELETE "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "msg": "Task Deleted", "status": 200 }

Error Responses

Project or task not found (HTTP 404):

{ "msg": "We couldn't find this task." }

The API user is not allowed to delete this task (HTTP 422):

{ "msg": "You don't have permission to perform this action." }

The task has tracked time (HTTP 409):

{ "msg": "This task has 3 tracked time entries and cannot be deleted. Archive it instead to preserve the history.", "entry_count": 3 }

Change Task Order

Set the position of tasks inside one container. Use it after reordering or after dropping tasks into a column. Every listed task is set to the given order value and moved into the target container (taking the container’s status and completion state).

POST /api/public-v1/project/{uuid}/task/change-order

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Request Body

FieldTypeRequiredDescription
container_idinteger or stringYesTarget container. 89 and container-89 are both accepted
orderarrayYesList of { "item_id": <task id>, "order": <position> }. Must be present and an array; a missing or non-array order is rejected with 422

Every item_id must be a task of this project; an unknown id makes the whole request return 404 (tasks listed before it have already been updated).

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/change-order" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "container_id": "container-89", "order": [ { "item_id": 247, "order": 1 }, { "item_id": 246, "order": 2 } ] }'

Example Response

{ "msg": "Task Order Changed", "status": 200 }

Error Responses

Project not found (HTTP 404):

{ "msg": "project not found" }

Validation failure (HTTP 422), for example a missing container_id or a missing/non-array order: { "success": false, "message": "Validation failed", "errors": { "container_id": ["The board column field is required."] } }.


Change Task Container

Move a task to another container (column). The task takes the status and completion state of the target container’s stage category.

POST /api/public-v1/project/{uuid}/task/{id}/change-container

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
container_idinteger or stringYesTarget container of the same project. 89 and container-89 are both accepted

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/change-container" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "container_id": 91 }'

Example Response

{ "msg": "Task Container Changed", "status": 200 }

Error Responses

Missing container_id (HTTP 422):

{ "msg": "container_id field is required" }

Not found (HTTP 404): the response msg is one of We couldn't find this project. It may have been deleted or you may no longer have access to it., We couldn't find this task. or We couldn't find this board column..


Change Task Priority

Change a task’s priority. The value must be a priority enum value: 0 Low, 1 Medium, 2 High or 3 Urgent.

POST /api/public-v1/project/{uuid}/task/{id}/change-priority

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
priorityintegerYes0 Low, 1 Medium, 2 High, 3 Urgent. 0 is accepted; an empty value is not

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/change-priority" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "priority": 3 }'

Example Response

{ "msg": "Task priority Changed", "status": 200 }

Error Responses

Missing priority (HTTP 422):

{ "msg": "Field is required" }

Value outside the priority enum (HTTP 422):

{ "msg": "Invalid priority value" }

Not found (HTTP 404): msg is We couldn't find this project. It may have been deleted or you may no longer have access to it. or We couldn't find this task..


Mark Task Complete

Mark a task complete or not complete. Completing moves the task to the project’s first Done container; re-opening a task that sits in a Done container moves it back to the first In Progress container (or To Do when there is none).

POST /api/public-v1/project/{uuid}/task/{id}/mark-as-complete

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
is_completedinteger or booleanYes1 / true marks the task complete, 0 / false marks it not complete. The key must be present

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/mark-as-complete" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "is_completed": 1 }'

Example Response

stats is the project-wide task progress after the change.

{ "msg": "Task Marked as Complete", "stats": { "total_tasks": 45, "completed_tasks": 30, "completion_percentage": 66.67 }, "status": 200 }

With is_completed set to 0 the message is Task Marked as Not Complete.

Error Responses

Missing is_completed (HTTP 422):

{ "msg": "is completed field is required" }

Not found (HTTP 404): { "msg": "project not found" } or { "msg": "task not found" }.


Add Task Label

Attach a label to a task. The call is idempotent: attaching a label that is already on the task returns the existing attachment.

POST /api/public-v1/project/{uuid}/task/{id}/label

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
label_idintegerYesId of a project attribute of type 1 (label). Create labels with Create Attribute

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/label" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "label_id": 14 }'

Example Response

{ "msg": "Label added", "data": { "id": 31, "task_id": 246, "attribute_id": 14, "attribute": { "color": "red", "title": "Backend", "type": 1 } } }

Error Responses

Validation failure (HTTP 422):

{ "error": { "label_id": ["The selected label id is invalid."] } }

The attribute exists but is not a label (HTTP 422):

{ "msg": "This attribute isn't a label." }

The API user may not edit this task (HTTP 422): { "msg": "You don't have permission to perform this action." }. Project or task not found: HTTP 404 with msg We couldn't find this project. It may have been deleted or you may no longer have access to it. or We couldn't find this task..


Remove Task Label

Detach a label from a task. The call is idempotent: removing a label that is not on the task still succeeds.

DELETE /api/public-v1/project/{uuid}/task/{id}/label

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
label_idintegerYesId of a label attribute (type 1)

Example Request

curl -X DELETE "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/label" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "label_id": 14 }'

Example Response

{ "msg": "Label removed" }

Error Responses

Same errors as Add Task Label: validation failure { "error": { "label_id": [...] } } (HTTP 422), This attribute isn't a label. (HTTP 422), permission refusal (HTTP 422) and 404 for an unknown project or task.


Add Task Assignee

Assign a member to a task. The assignment is recorded as made by the API user (assigned_by), and the assignee is notified and starts watching the task.

This call is idempotent: if the member is already assigned to the task, it returns 200 with the existing assignment, creates no duplicate and does not notify the member again.

POST /api/public-v1/project/{uuid}/task/{id}/assignee

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
assignee_idintegerYesUser id of the member to assign

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/assignee" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "assignee_id": 8 }'

Example Response

{ "msg": "Task Assignee added", "data": { "task_id": 246, "assignee_id": { "id": 8, "uuid": "2e4a6c8e-0b75-4d91-8c23-7a9b1d3f5e08", "first_name": "David", "last_name": "Chen", "full_name": "David Chen", "email": "david@company.com", "timezone": "UTC", "image": null }, "assigned_by": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "first_name": "Sarah", "last_name": "Johnson", "full_name": "Sarah Johnson", "email": "sarah@company.com", "timezone": "UTC", "image": null }, "created_at": "06/Mar/2024", "id": 313 }, "status": 200 }

Error Responses

No assignee_id sent (HTTP 422):

{ "msg": "Please select a member to assign." }

Member, project or task not found (HTTP 404): msg is We couldn't find this member., We couldn't find this project. It may have been deleted or you may no longer have access to it. or We couldn't find this task..


Remove Task Assignee

Remove a member from a task.

DELETE /api/public-v1/project/{uuid}/task/{id}/assignee

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
assignee_idintegerYesUser id of the member to remove

Example Request

curl -X DELETE "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/assignee" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "assignee_id": 8 }'

Example Response

{ "msg": "Task Assignee remove", "status": 200 }

Error Responses

No assignee_id sent (HTTP 422):

{ "msg": "Please select a member to assign." }

The member is not assigned to this task (HTTP 404):

{ "msg": "This member isn't assigned to this task." }

Unknown member, project or task (HTTP 404): msg is We couldn't find this member., We couldn't find this project. It may have been deleted or you may no longer have access to it. or We couldn't find this task..


Get Task Documents

List the documents attached to a task.

GET /api/public-v1/project/{uuid}/task/{id}/document

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/document" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "data": [ { "task_id": 246, "document_id": 57, "document": { "id": 57, "uuid": "e1f3a5c7-9b04-4d26-8f48-0a2c4e6a8b57", "name": "API Authentication Spec", "thumbnail": null }, "id": 246 } ], "status": 200 }

id repeats the task id (it is not a link id). Use document_id when removing a document.

Error Responses

Project or task not found (HTTP 404): msg is We couldn't find this project. It may have been deleted or you may no longer have access to it. or We couldn't find this task..


Add Task Document

Attach an existing document to a task.

POST /api/public-v1/project/{uuid}/task/{id}/document

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
document_idintegerYesId of a document in your workspace (see the Document Management API). Must exist, otherwise 404. Attaching the same document twice returns the existing link instead of creating a duplicate

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/document" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "document_id": 57 }'

Example Response

{ "msg": "Task Document added", "data": { "task_id": 246, "document_id": 57, "document": { "id": 57, "uuid": "e1f3a5c7-9b04-4d26-8f48-0a2c4e6a8b57", "name": "API Authentication Spec", "thumbnail": null }, "id": 246 }, "status": 200 }

Error Responses

No document_id sent (HTTP 422):

{ "msg": "Please select a document." }

Project or task not found (HTTP 404): msg is We couldn't find this project. It may have been deleted or you may no longer have access to it. or We couldn't find this task..

Unknown document_id (HTTP 404):

{ "msg": "Document not found" }

Remove Task Document

Detach a document from a task. The document itself is not deleted.

DELETE /api/public-v1/project/{uuid}/task/{id}/document

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
document_idintegerYesId of the attached document

Example Request

curl -X DELETE "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/document" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "document_id": 57 }'

Example Response

{ "msg": "Task Document removed", "status": 200 }

Error Responses

No document_id sent (HTTP 422):

{ "msg": "Please select a document." }

The document is not attached to the task (HTTP 404):

{ "msg": "We couldn't find this document." }

Project or task not found (HTTP 404): msg is We couldn't find this project. It may have been deleted or you may no longer have access to it. or We couldn't find this task..


Get Task Comments

List the top-level comments of a task, oldest first, each with its replies. Internal (staff-only) comments are hidden from client users.

GET /api/public-v1/project/{uuid}/task/{id}/comment

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/comment" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "data": [ { "id": 77, "task_id": 246, "parent_id": null, "description": "Started working on the JWT middleware.", "is_internal": false, "edited_at": null, "user": { "id": 8, "uuid": "2e4a6c8e-0b75-4d91-8c23-7a9b1d3f5e08", "first_name": "David", "last_name": "Chen", "full_name": "David Chen", "email": "david@company.com", "timezone": "UTC", "image": null }, "createdAt": "05 Mar 2024 14:30", "created_at_iso": "2024-03-05T14:30:00+00:00", "reactions": [ { "emoji": "👍", "count": 1, "reacted": false } ], "attachments": [], "replies": [ { "id": 78, "task_id": 246, "parent_id": 77, "description": "Looks good, thanks.", "is_internal": false, "edited_at": null, "user": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "first_name": "Sarah", "last_name": "Johnson", "full_name": "Sarah Johnson", "email": "sarah@company.com", "timezone": "UTC", "image": null }, "createdAt": "05 Mar 2024 15:02", "created_at_iso": "2024-03-05T15:02:00+00:00", "reactions": [], "attachments": [], "can_edit": true, "can_delete": true } ], "replies_count": 1, "can_edit": true, "can_delete": true } ], "status": 200 }

Error Responses

Project, task not found, or task not visible to the API user (HTTP 404):

{ "msg": "task not found" }

The project case returns { "msg": "project not found" }.


Add Task Comment

Add a comment to a task, or a reply to an existing top-level comment.

POST /api/public-v1/project/{uuid}/task/{id}/comment

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
descriptionstringYesComment text (HTML allowed; max 20000 characters). span elements carrying data-mention-id notify the mentioned users
parent_idintegerNoId of a top-level comment on the same task to reply to. Replies cannot be nested
is_internalbooleanNotrue posts a staff-only comment. Not available to client users
attachment_idsarrayNoUp to 10 media upload ids. Each must be an unattached upload created by the API user

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/comment" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "description": "Started working on the JWT middleware.", "is_internal": false }'

Example Response

{ "msg": "Task comment added", "data": { "id": 77, "task_id": 246, "parent_id": null, "description": "Started working on the JWT middleware.", "is_internal": false, "edited_at": null, "user": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "first_name": "Sarah", "last_name": "Johnson", "full_name": "Sarah Johnson", "email": "sarah@company.com", "timezone": "UTC", "image": null }, "createdAt": "05 Mar 2024 14:30", "created_at_iso": "2024-03-05T14:30:00+00:00", "reactions": [], "attachments": [], "replies_count": 0, "can_edit": true, "can_delete": true }, "status": 200 }

Error Responses

Validation failure (HTTP 422):

{ "error": { "description": ["The description field is required."] } }

Business-rule failures (HTTP 422): { "msg": "You can only reply to a top-level comment." }, { "msg": "One or more attachments are invalid." }, and { "msg": "You don't have permission to perform this action." } (for example is_internal by a client). Unknown project, task, or parent comment: HTTP 404 with msg project not found, task not found or comment not found.


Remove Task Comment

Delete a comment (and its replies and attachments). Only the comment’s author, an administrator/manager, or the project lead may delete it.

DELETE /api/public-v1/project/{uuid}/task/{id}/comment

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
comment_idintegerYesId of the comment to delete

Example Request

curl -X DELETE "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/246/comment" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "comment_id": 77 }'

Example Response

{ "msg": "Task comment deleted", "status": 200 }

Error Responses

No comment_id sent (HTTP 422):

{ "msg": "comment id field is required" }

Not allowed to delete this comment (HTTP 422): { "msg": "You don't have permission to perform this action." }. Unknown project, task or comment: HTTP 404 with msg project not found, task not found or comment not found.


Get All Task Files

Get every file attached to any task of a project. Files that are not visible to the API user (for example internal files, for a client user) are left out.

GET /api/public-v1/project/{uuid}/task/files

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/files" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "status": 200, "msg": "Project task files retrieved successfully", "data": [ { "id": 41, "task_id": 245, "media": { "id": 12, "title": "schema.sql", "ext": "sql", "size": 5120, "url": "https://storage.taskip.net/tenant-123/files/schema.sql", "media_type": "file", "createdAt": "22-02-2024 10:30:15" }, "client_visible": true, "createdAt": "22-Feb-2024 10:30:15" } ] }

Error Responses

Project not found (HTTP 404):

{ "status": 404, "msg": "We couldn't find this project. It may have been deleted or you may no longer have access to it." }

Get Task Files

Get the files attached to one task.

GET /api/public-v1/project/{uuid}/task/{id}/files

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/245/files" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

The msg text of this list response is Task file added (the same text the upload returns); ignore it and read data.

{ "msg": "Task file added", "data": [ { "id": 41, "task_id": 245, "media": { "id": 12, "title": "schema.sql", "ext": "sql", "size": 5120, "url": "https://storage.taskip.net/tenant-123/files/schema.sql", "media_type": "file", "createdAt": "22-02-2024 10:30:15" }, "client_visible": true, "createdAt": "22-Feb-2024 10:30:15" } ], "status": 200 }

Error Responses

Project or task not found, or the task is not visible to the API user (HTTP 404): msg is We couldn't find this project. It may have been deleted or you may no longer have access to it. or We couldn't find this task..


Upload Task File

Attach an already-uploaded file to a task. The API does not receive the file itself here: file_id is the id of an existing media upload in your workspace.

POST /api/public-v1/project/{uuid}/task/{id}/files

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
file_idintegerYesId of an existing media upload to attach. An unknown id is rejected with 404 and nothing is created
client_visiblebooleanNoWhether clients can see this file. Defaults to the project’s default client visibility

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/245/files" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "file_id": 12, "client_visible": true }'

Example Response

{ "msg": "Task file added", "data": { "id": 41, "task_id": 245, "media": { "id": 12, "title": "schema.sql", "ext": "sql", "size": 5120, "url": "https://storage.taskip.net/tenant-123/files/schema.sql", "media_type": "file", "createdAt": "22-02-2024 10:30:15" }, "client_visible": true, "createdAt": "22-Feb-2024 10:30:15" }, "status": 200 }

Error Responses

Validation failure (HTTP 422):

{ "error": { "file_id": ["The file id field is required."] } }

Project or task not found (HTTP 404): msg is We couldn't find this project. It may have been deleted or you may no longer have access to it. or We couldn't find this task..

Unknown file_id (HTTP 404):

{ "msg": "File not found" }

Delete Task File

Remove a file from a task. The uploaded file itself is deleted from storage.

DELETE /api/public-v1/project/{uuid}/task/{id}/files

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesTask id

Request Body

FieldTypeRequiredDescription
file_idintegerYesThe media id (media.id) of the attached file

Example Request

curl -X DELETE "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/task/245/files" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "file_id": 12 }'

Example Response

{ "msg": "Task file deleted", "status": 200 }

Error Responses

File not attached to this task (HTTP 404):

{ "msg": "We couldn't find this file." }

Project or task not found (HTTP 404): msg is We couldn't find this project. It may have been deleted or you may no longer have access to it. or We couldn't find this task..


Get Project Files

Get all uploaded files related to a project: files posted in the project discussion and files attached to its tasks, as media objects.

GET /api/public-v1/project/{uuid}/files

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/files" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "data": [ { "id": 12, "title": "schema.sql", "ext": "sql", "size": 5120, "url": "https://storage.taskip.net/tenant-123/files/schema.sql", "media_type": "file", "createdAt": "22-02-2024 10:30:15" }, { "id": 18, "title": "kickoff-notes.pdf", "ext": "pdf", "size": 204800, "url": "https://storage.taskip.net/tenant-123/files/kickoff-notes.pdf", "media_type": "file", "createdAt": "01-03-2024 09:12:44" } ] }

Error Responses

Project not found (HTTP 404):

{ "msg": "Project not found" }

Get Project Discussions

Get all messages of a project’s discussion. The list is not paginated.

GET /api/public-v1/project/{uuid}/discussion

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/discussion" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "data": [ { "id": 301, "status": 1, "msg_content": "Kickoff is scheduled for Monday.", "user_id": 3, "project_id": null, "createdAt": "01 Mar 2024 09:12:44", "date": "01 Mar 2024", "user": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "name": "Sarah Johnson", "media": null }, "attachment": { "id": 18, "title": "kickoff-notes.pdf", "ext": "pdf", "size": 204800, "url": "https://storage.taskip.net/tenant-123/files/kickoff-notes.pdf", "media_type": "file", "createdAt": "01-03-2024 09:12:44" }, "parent": null, "reactions": [], "isEdited": false, "isVoiceMessage": false, "voiceDuration": null, "is_pinned": false } ] }

parent is null when the message is not a reply; when it is a reply it holds { id, project_uuid, user, msg_content, status, created_at } of the parent message. attachment is the message’s single media object, or null when there is none. The list is cached for about 10 seconds per user. Posting a message clears the poster’s own cached list, so your new message shows up immediately; other members may take up to 10 seconds to see it.

Error Responses

Project not found (HTTP 404):

{ "msg": "We couldn't find this project. It may have been deleted or you may no longer have access to it." }

Create Discussion

Post a message to a project’s discussion. The author is the API user.

POST /api/public-v1/project/{uuid}/discussion

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Request Body

FieldTypeRequiredDescription
msgstringYesMessage text
attachmentarrayNoArray holding the id of an existing media upload. Only the first id is used; the message carries one attachment

Other fields accepted by validation (replyToId, isEdited, isVoiceMessage, duration) are not stored by this endpoint.

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/discussion" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "msg": "Kickoff is scheduled for Monday.", "attachment": [18] }'

Example Response

{ "msg": "Message Send Successfully", "data": { "id": 301, "status": 1, "msg_content": "Kickoff is scheduled for Monday.", "user_id": 3, "project_id": null, "createdAt": "01 Mar 2024 09:12:44", "date": "01 Mar 2024", "user": { "id": 3, "uuid": "5a7c9e1b-3d52-4f68-a0b4-8c2e4f6a8d03", "name": "Sarah Johnson", "media": null }, "attachment": { "id": 18, "title": "kickoff-notes.pdf", "ext": "pdf", "size": 204800, "url": "https://storage.taskip.net/tenant-123/files/kickoff-notes.pdf", "media_type": "file", "createdAt": "01-03-2024 09:12:44" }, "parent": null, "reactions": [], "isEdited": false, "isVoiceMessage": false, "voiceDuration": null, "is_pinned": false } }

Error Responses

Validation failure (HTTP 422):

{ "error": { "msg": ["The msg field is required."] } }

Project not found (HTTP 404): msg is We couldn't find this project. It may have been deleted or you may no longer have access to it..


Get Discussion Files

Get the files that were attached to messages of the project’s discussion.

GET /api/public-v1/project/{uuid}/discussion/files

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/discussion/files" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "data": [ { "id": 18, "title": "kickoff-notes.pdf", "ext": "pdf", "size": 204800, "url": "https://storage.taskip.net/tenant-123/files/kickoff-notes.pdf", "media_type": "file", "createdAt": "01-03-2024 09:12:44" } ] }

Error Responses

Project not found (HTTP 404): msg is We couldn't find this project. It may have been deleted or you may no longer have access to it..


Create Container

Create a container (board column) in a project. Containers are ordered by order.

POST /api/public-v1/project/{uuid}/container

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Request Body

FieldTypeRequiredDescription
titlestringYesContainer title (max 191 characters)
colorstringNoColor name, e.g. slate, yellow, blue, purple, green
orderintegerNoPosition among the containers
categorystringNoStage category: todo, in_progress, review or done. Tasks in a done container are treated as completed. backlog cannot be set

Every project is created with five containers: Backlog (backlog, system), To Do, In Progress, Review and Done.

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/container" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "title": "QA", "color": "purple", "order": 4, "category": "review" }'

Example Response

{ "msg": "New Container Added", "data": { "id": 92, "project_uuid": "c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26", "title": "QA", "color": "purple", "order": 4, "category": "review", "is_system": false, "created_at": "06/Mar/2024" } }

Error Responses

Validation failure (HTTP 422):

{ "error": { "title": ["The title field is required."], "category": ["The selected category is invalid."] } }

Rename Container

Change a container’s title.

PUT /api/public-v1/project/{uuid}/container/{id}/rename

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesContainer id

Request Body

FieldTypeRequiredDescription
titlestringYesNew title

Example Request

curl -X PUT "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/container/92/rename" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "title": "Quality Assurance" }'

Example Response

{ "msg": "Title changed" }

Error Responses

Missing title, or a container that does not belong to the project, are refused with HTTP 422 (not 404):

{ "error": { "msg": ["title field is required"] } }
{ "error": { "msg": ["Container not found"] } }

Change Container Color

Change a container’s color.

POST /api/public-v1/project/{uuid}/container/{id}/change-color

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesContainer id

Request Body

FieldTypeRequiredDescription
colorstringYesColor name, e.g. green

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/container/92/change-color" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "color": "green" }'

Example Response

{ "msg": "Color changed" }

Error Responses

Missing color or unknown container (HTTP 422):

{ "error": { "msg": ["Color field is required"] } }

An unknown container returns { "error": { "msg": ["Container not found"] } }.


Change Container Order

Set the position of containers. The request body is a JSON array (not an object): each element gives a container and its new order.

POST /api/public-v1/project/{uuid}/container/change-order

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID

Request Body

A JSON array of objects:

FieldTypeRequiredDescription
container_idinteger or stringYesContainer id. 92 and container-92 are both accepted. Elements whose container_id is null are skipped
orderintegerYesNew position

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/container/change-order" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '[ { "container_id": "container-89", "order": 2 }, { "container_id": "container-92", "order": 3 }, { "container_id": "container-90", "order": 4 } ]'

Example Response

{ "msg": "Container Order changed" }

Error Responses

Empty body (HTTP 422):

{ "error": { "msg": ["Order field is required"] } }

Delete Container

Delete a container. The system Backlog container cannot be deleted, and neither can the last remaining Done container.

DELETE /api/public-v1/project/{uuid}/container/{id}/delete

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesContainer id

Example Request

curl -X DELETE "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/container/92/delete" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "msg": "Container deleted" }

Error Responses

Container not found for this project (HTTP 422):

{ "error": { "msg": ["Container not found"] } }

Protected containers (HTTP 422):

{ "msg": "The backlog stage cannot be changed." }
{ "msg": "A project needs at least one Done stage." }

Consider moving the container’s tasks first with Move All Tasks.


Move All Tasks

Move every task of one container into another container of the same project.

POST /api/public-v1/project/{uuid}/container/{id}/move-all-tasks

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesProject UUID
idintegerYesSource container id

Request Body

FieldTypeRequiredDescription
to_container_idintegerYesTarget container id. Must be a container of the same project

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/c4e6a8b0-2d13-4f57-9b81-3a5c7e9f1b26/container/92/move-all-tasks" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "to_container_id": 90 }'

Example Response

{ "msg": "Container Move All Task Successfully" }

Error Responses

Target container missing or not part of this project (HTTP 422):

{ "msg": "Target container not found" }

Source container not found (HTTP 422):

{ "error": { "msg": ["Container not found"] } }

Get All Attributes

List project attributes. Attributes are the shared tags, categories and labels used across projects and tasks. Send type to list one type; without type, attributes of all types are returned.

GET /api/public-v1/project/attribute/all

Query Parameters

ParameterTypeRequiredDescription
typeintegerNoAttribute type filter: 0 Priority, 1 Label, 2 Category, 3 Tag, 4 Status
searchstringNoMatches the attribute title (partial match)
itemintegerNoAttributes per page (default: 10). 0 returns all without pagination
pageintegerNoPage number

Example Request

curl -X GET "https://public-api.taskip.net/api/public-v1/project/attribute/all?type=3&item=50" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "data": [ { "id": 7, "title": "priority-client", "color": "red", "type": 3 }, { "id": 6, "title": "platform", "color": "blue", "type": 3 }, { "id": 4, "title": "website", "color": "orange", "type": 3 } ], "links": { "first": "https://public-api.taskip.net/api/public-v1/project/attribute/all?page=1", "last": "https://public-api.taskip.net/api/public-v1/project/attribute/all?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "https://public-api.taskip.net/api/public-v1/project/attribute/all", "per_page": 50, "to": 3, "total": 3 } }

Attributes are returned newest first (highest id first).


Create Attribute

Create a project attribute (tag, category, label, priority or status).

POST /api/public-v1/project/attribute

Request Body

FieldTypeRequiredDescription
titlestringYesAttribute title (max 191 characters)
colorstringYesColor name (max 50 characters), e.g. slate, red, blue
typeintegerYes0 Priority, 1 Label, 2 Category, 3 Tag, 4 Status

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/attribute" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "title": "Mobile", "color": "blue", "type": 2 }'

Example Response

{ "msg": "Project Attribute Created Successfully", "data": { "id": 18, "title": "Mobile", "color": "blue", "type": 2 } }

Error Responses

Validation failure (HTTP 422):

{ "error": { "title": ["The title field is required."], "type": ["The selected type is invalid."] } }

Update Attribute

Update an attribute. The body is validated like Create Attribute: title, color and type are all required.

PUT /api/public-v1/project/attribute/{id}/update

Path Parameters

ParameterTypeRequiredDescription
idintegerYesAttribute id

Request Body

FieldTypeRequiredDescription
titlestringYesMax 191 characters
colorstringYesMax 50 characters
typeintegerYes0 Priority, 1 Label, 2 Category, 3 Tag, 4 Status

Example Request

curl -X PUT "https://public-api.taskip.net/api/public-v1/project/attribute/18/update" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "title": "Mobile Apps", "color": "indigo", "type": 2 }'

Example Response

{ "msg": "Project Attribute Updated" }

Error Responses

Attribute not found (HTTP 404):

{ "msg": "We couldn't find this attribute.", "status": 404 }

Validation failure (HTTP 422): { "error": { "field": ["..."] } }.


Delete Attribute

Delete an attribute.

DELETE /api/public-v1/project/attribute/{id}/delete

Path Parameters

ParameterTypeRequiredDescription
idintegerYesAttribute id

Example Request

curl -X DELETE "https://public-api.taskip.net/api/public-v1/project/attribute/18/delete" \ -H "X-Secret-Key: your-secret-key-here"

Example Response

{ "msg": "Project Attribute Deleted" }

Error Responses

Attribute not found (HTTP 404):

{ "msg": "We couldn't find this attribute.", "status": 404 }

Permission refusal (HTTP 422): { "error": { "msg": ["You don't have permission to delete this attribute."] } }.


Bulk Update Tags

Create or update several tag attributes in one call. Each element is matched by id: an existing id is updated; an element without id (or with null) creates a new attribute. Attributes that are not listed are left untouched (nothing is deleted).

POST /api/public-v1/project/attribute/tags/update

Request Body

FieldTypeRequiredDescription
tagsarrayYesList of attribute objects (see below)
tags[].idinteger or nullNoExisting attribute id to update; omit or null to create
tags[].titlestringYesAttribute title (max 191 characters)
tags[].colorstringNoColor name (max 50 characters); defaults to slate
tags[].typeintegerYesAttribute type. Use 3 (Tag) for tags

The input is validated before anything is written. A missing tags array or an invalid item returns HTTP 422 in the standard validation shape, for example:

{ "success": false, "message": "Validation failed", "errors": { "tags.1.title": ["The tags.1.title field is required."] } }

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/attribute/tags/update" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "tags": [ { "id": 4, "title": "website", "color": "orange", "type": 3 }, { "id": null, "title": "urgent-client", "color": "red", "type": 3 } ] }'

Example Response

{ "msg": "Project Tags Updated" }

Bulk Update Categories

Create or update several category attributes in one call. Each element is matched by id: an existing id is updated; an element without id (or with null) creates a new attribute. Attributes that are not listed are left untouched (nothing is deleted).

POST /api/public-v1/project/attribute/categories/update

Request Body

FieldTypeRequiredDescription
categoriesarrayYesList of attribute objects (see below). The historical misspelling categroies is also accepted
categories[].idinteger or nullNoExisting attribute id to update; omit or null to create
categories[].titlestringYesAttribute title (max 191 characters)
categories[].colorstringNoColor name (max 50 characters); defaults to slate
categories[].typeintegerYesAttribute type. Use 2 (Category) for categories

The input is validated before anything is written. If neither categories nor categroies is sent, or an item is invalid, the call returns HTTP 422 in the standard validation shape (errors keys look like categories.0.title).

Example Request

curl -X POST "https://public-api.taskip.net/api/public-v1/project/attribute/categories/update" \ -H "X-Secret-Key: your-secret-key-here" \ -H "Content-Type: application/json" \ -d '{ "categories": [ { "id": 9, "title": "Development", "color": "green", "type": 2 }, { "id": null, "title": "Design", "color": "purple", "type": 2 } ] }'

Example Response

{ "msg": "Project Category Updated" }

Error Responses

Errors in this API come in a few shapes. Check the HTTP status first, then the body.

Common Status Codes

Status CodeMeaningTypical cause
401UnauthorizedX-Secret-Key header missing: { "message": "Secret keys are missing." }
404Not FoundUnknown secret key ({ "status": 404, "msg": "Workspace not found" }), or a project, task, comment, member or attribute that does not exist or is not visible to the API user
409ConflictTask cannot be deleted because it has tracked time
422UnprocessableValidation failed, a business rule refused the request, or the API user lacks permission
429Too Many RequestsRate limit exceeded
500Server ErrorUnexpected failure

Validation Errors: error keyed by field

Request validation for project create/update, task create/update, labels, comments, task files, discussion, containers and attributes returns HTTP 422:

{ "error": { "title": ["The title field is required."], "priority": ["The selected priority is invalid."] } }

Validation Errors: errors keyed by field

Endpoints that validate inline (All Tasks List, Change Project Priority/Status/Category, Bulk Update Tags/Categories) and Change Task Order return HTTP 422:

{ "success": false, "message": "Validation failed", "errors": { "category": ["The category field is required."] } }

Permission Refusals and Container Lookups: error.msg

Permission refusals (Create Project, Update Project, Delete Project, Change Project Priority/Status/Category, Delete Attribute) and container lookups that fail return HTTP 422 with a list of messages under error.msg. Create Project and Delete Project check the permissions of the API key’s user; some project-level role and scope checks (for example on Update Project) are bypassed for API-key requests, so those variants are not expected in practice. The container lookups (Container not found, title field is required) are:

{ "error": { "msg": ["You don't have permission to update project"] } }

Plain msg Errors

Lookups and business-rule failures return a single msg:

{ "msg": "We couldn't find this task." }

The status code tells them apart: 404 for a missing resource, 422 for a rule such as Target container not found, Please select a member to assign., The milestone belongs to another project., The container belongs to another project. or Invalid priority value, and 409 for a task that has tracked time. A few endpoints return additional keys, for example entry_count on the 409 and data.open_items when Change Project Status is blocked by the close-out checklist.

Last updated on