API Documentation
Projects ¶
Projects ¶
For more details on how to work with custom fields please refer to Working with custom fields guide.
Note: For archived projects, only the
name
andproject_manager_id
attributes can be updated. All other attributes will be ignored during update operations.
Supported filter params
-
id
-
project_type (1: internal, 2: client)
-
company_id (array)
-
responsible_id (array)
-
person_id (array)
-
status (1: active, 2: archived)
-
query
Filter operations are supported on this endpoint.
GET /api/v2/projects
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "813",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:24.000+02:00",
"public_access": true,
"time_on_tasks": true,
"tag_colors": {},
"archived_at": null,
"created_at": "2025-07-24T06:07:24.672+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1013"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
{
"id": "815",
"type": "projects",
"attributes": {
"name": "test project",
"number": "3",
"preferences": {},
"project_number": "3",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:24.000+02:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2025-07-24T06:07:24.732+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1013"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
{
"id": "816",
"type": "projects",
"attributes": {
"name": "test project",
"number": "4",
"preferences": {},
"project_number": "4",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:24.000+02:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2025-07-24T06:07:24.745+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1013"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/projects?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/projects?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 3,
"page_size": 30,
"max_page_size": 200
}
}
Get projectsGET/api/v2/projects
GET /api/v2/projects/821
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "821",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:25.000+02:00",
"public_access": true,
"time_on_tasks": true,
"tag_colors": {},
"archived_at": null,
"created_at": "2025-07-24T06:07:25.023+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1015"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/projects
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": "test name",
"project_type_id": 2
},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "2649"
}
},
"project_manager": {
"data": {
"type": "people",
"id": "3584"
}
},
"workflow": {
"data": {
"type": "workflows",
"id": "915"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "823",
"type": "projects",
"attributes": {
"name": "test name",
"number": "2",
"preferences": null,
"project_number": "2",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:25.000+02:00",
"public_access": false,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2025-07-24T06:07:25.143+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": {},
"page_custom_fields_ids": null,
"page_custom_fields_positions": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1016"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/projects
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/workflow"
}
}
]
}
Create a projectPOST/api/v2/projects
- name
string
(required) Example: Namename
- project_manager_id
number
(required) Example: 1project manager id
- company_id
number
(required) Example: 1company id
- workflow_id
number
(required) Example: 1worfklow id
PATCH /api/v2/projects/828
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": "new name"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "828",
"type": "projects",
"attributes": {
"name": "new name",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:25.000+02:00",
"public_access": true,
"time_on_tasks": true,
"tag_colors": {},
"archived_at": null,
"created_at": "2025-07-24T06:07:25.483+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": {},
"page_custom_fields_ids": null,
"page_custom_fields_positions": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1021"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/projects/829
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": "new name",
"project_manager_id": 3591,
"project_type_id": 2,
"project_color_id": 2
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "829",
"type": "projects",
"attributes": {
"name": "new name",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 1,
"project_color_id": 1,
"last_activity_at": "2025-07-24T06:07:25.000+02:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": "2025-07-24T06:07:25.000+02:00",
"created_at": "2025-07-24T06:07:25.551+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": {},
"page_custom_fields_ids": null,
"page_custom_fields_positions": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1022"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/projects/830
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}
PATCH /api/v2/projects/831
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"workflow_id": 928
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "831",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:25.000+02:00",
"public_access": true,
"time_on_tasks": true,
"tag_colors": {},
"archived_at": null,
"created_at": "2025-07-24T06:07:25.937+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": {},
"page_custom_fields_ids": null,
"page_custom_fields_positions": {},
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1024"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/projects/832/archive
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "832",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:26.000+02:00",
"public_access": true,
"time_on_tasks": true,
"tag_colors": {},
"archived_at": "2025-07-24T06:07:26.000+02:00",
"created_at": "2025-07-24T06:07:26.100+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1025"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Archives a projectPATCH/api/v2/projects/{id}/archive
- id
number
(required) Example: 1project id
PATCH /api/v2/projects/833/restore
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "833",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:26.000+02:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2025-07-24T06:07:26.262+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1026"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Restores a projectPATCH/api/v2/projects/{id}/restore
- id
number
(required) Example: 1project id
DELETE /api/v2/projects/834
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
POST /api/v2/projects/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": "This is a name",
"template_id": 835,
"company_id": 2674,
"project_type_id": 2,
"copy_project_members": true,
"copy_boards": true,
"copy_task_lists": true,
"copy_open_tasks": true,
"copy_closed_tasks": false,
"copy_task_comments": false,
"copy_task_subscribers": false,
"copy_assignees": false,
"copy_tags": false,
"copy_estimate": true,
"copy_views": true
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "836",
"type": "projects",
"attributes": {
"name": "This is a name",
"number": "2",
"preferences": {},
"project_number": "2",
"project_color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1028"
}
},
"company": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/projects/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": "This is a name",
"template_id": 837,
"company_id": 2677,
"project_type_id": 2,
"copy_project_members": true,
"copy_boards": true,
"copy_task_lists": true,
"copy_open_tasks": false,
"copy_closed_tasks": true,
"copy_task_comments": false,
"copy_task_subscribers": false,
"copy_assignees": false,
"copy_tags": false,
"copy_estimate": true,
"copy_views": true
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "838",
"type": "projects",
"attributes": {
"name": "This is a name",
"number": "2",
"preferences": {},
"project_number": "2",
"project_color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1029"
}
},
"company": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/projects/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": "This is a name",
"template_id": 839,
"company_id": 2681,
"project_type_id": 2,
"copy_project_members": true,
"copy_boards": true,
"copy_task_lists": true,
"copy_open_tasks": true,
"copy_task_comments": false,
"copy_task_subscribers": false,
"copy_assignees": false,
"copy_tags": false,
"copy_estimate": true,
"copy_views": true,
"copy_budgets": true
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "840",
"type": "projects",
"attributes": {
"name": "This is a name",
"number": "2",
"preferences": {},
"project_number": "2",
"project_color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1030"
}
},
"company": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/projects/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": "This is a name",
"public_access": false,
"template_id": 841,
"project_type_id": 1,
"copy_project_members": true,
"copy_boards": true,
"copy_task_lists": true,
"copy_open_tasks": true,
"copy_task_comments": false,
"copy_task_subscribers": false,
"copy_assignees": false,
"copy_tags": false,
"copy_estimate": true
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "842",
"type": "projects",
"attributes": {
"name": "This is a name",
"number": "2",
"preferences": {},
"project_number": "2",
"project_color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1031"
}
},
"company": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/projects/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/template_id"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/project_type_id"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not included in the list",
"source": {
"pointer": "data/attributes/project_type_id"
}
}
]
}
POST /api/v2/projects/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": "This is a name",
"description": "This is a description",
"template_id": 845,
"company_id": 2688,
"project_type_id": 2,
"copy_project_members": true,
"copy_boards": true,
"copy_task_lists": true,
"copy_open_tasks": true,
"copy_task_comments": false,
"copy_task_subscribers": false,
"copy_assignees": false,
"copy_tags": false,
"copy_estimate": true,
"copy_views": true,
"copy_as_template": true
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "846",
"type": "projects",
"attributes": {
"name": "This is a name",
"number": null,
"preferences": {},
"project_number": null,
"project_color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1033"
}
},
"company": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/projects/copy
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"name": "This is a name",
"template_id": 849,
"company_id": 2692,
"project_type_id": 2,
"copy_project_members": true,
"copy_boards": true,
"copy_task_lists": true,
"copy_open_tasks": true,
"copy_task_comments": false,
"copy_task_subscribers": false,
"copy_assignees": false,
"copy_tags": false,
"copy_estimate": true,
"copy_views": true,
"copy_as_template": false
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "850",
"type": "projects",
"attributes": {
"name": "This is a name",
"number": "4",
"preferences": {},
"project_number": "4",
"project_color_id": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1034"
}
},
"company": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Copies a projectPOST/api/v2/projects/copy
PATCH /api/v2/projects/863/change_workflow
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"map": {
"1106": 1110,
"1107": 1111,
"1108": 1110
}
},
"relationships": {
"workflow": {
"data": {
"type": "workflows",
"id": "981"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "863",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:29.000+02:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2025-07-24T06:07:29.312+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1036"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/projects/874/change_workflow
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"map": {}
},
"relationships": {
"workflow": {
"data": {
"type": "workflows",
"id": "1004"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/map"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "must have 2 (including one closed) or more workflow statuses defined",
"source": {
"pointer": "data/attributes/workflow"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "doesn't contain all statuses from current project workflow",
"source": {
"pointer": "data/attributes/map"
}
}
]
}
PATCH /api/v2/projects/885/change_workflow
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"map": {
"1139": 1143,
"1140": 1144,
"1141": 1143
}
},
"relationships": {
"workflow": {
"data": {
"type": "workflows",
"id": "0"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/workflow"
}
}
]
}
PATCH /api/v2/projects/896/change_workflow
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {},
"relationships": {
"workflow": {
"data": {
"type": "workflows",
"id": "1018"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/map"
}
}
]
}
PATCH /api/v2/projects/907/change_workflow
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"map": {
"1171": 1175,
"1172": 1176
}
},
"relationships": {
"workflow": {
"data": {
"type": "workflows",
"id": "1030"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "doesn't contain all statuses from current project workflow",
"source": {
"pointer": "data/attributes/map"
}
}
]
}
PATCH /api/v2/projects/918/change_workflow
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"map": {
"1187": 1191,
"1188": "0",
"1189": 1191
}
},
"relationships": {
"workflow": {
"data": {
"type": "workflows",
"id": "1042"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "contains invalid statuses",
"source": {
"pointer": "data/attributes/map"
}
}
]
}
Changes workflow on projectPATCH/api/v2/projects/change_workflow
- workflow_id
number
(required) Example: 1workflow id
- map
json
(required) Example: %7B+1%3A+5%2C+2%3A+6+%7Dmapping from current workflow statuses to new workflow statuses
PATCH /api/v2/projects/934/map_to_workflow
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"map": {
"151": 1215,
"152": 1216,
"153": 1214
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "934",
"type": "projects",
"attributes": {
"name": "test project",
"number": "1",
"preferences": {},
"project_number": "1",
"project_type_id": 2,
"project_color_id": null,
"last_activity_at": "2025-07-24T06:07:33.000+02:00",
"public_access": true,
"time_on_tasks": false,
"tag_colors": {},
"archived_at": null,
"created_at": "2025-07-24T06:07:33.648+02:00",
"template": false,
"custom_fields": null,
"task_custom_fields_ids": null,
"task_custom_fields_positions": null,
"page_custom_fields_ids": null,
"page_custom_fields_positions": null,
"sample_data": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "1043"
}
},
"company": {
"meta": {
"included": false
}
},
"project_manager": {
"meta": {
"included": false
}
},
"last_actor": {
"meta": {
"included": false
}
},
"workflow": {
"meta": {
"included": false
}
},
"custom_field_people": {
"meta": {
"included": false
}
},
"custom_field_attachments": {
"meta": {
"included": false
}
},
"template_object": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/projects/938/map_to_workflow
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/map"
}
}
]
}
PATCH /api/v2/projects/942/map_to_workflow
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"map": {
"0": 1230,
"157": 1229
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "contains invalid task_list_id",
"source": {
"pointer": "data/attributes/map"
}
}
]
}
PATCH /api/v2/projects/946/map_to_workflow
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "projects",
"attributes": {
"map": {
"160": 1240,
"161": "0"
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "contains invalid statuses",
"source": {
"pointer": "data/attributes/map"
}
}
]
}
Change workflow on project and map task lists to workflow statuses on project tasksPATCH/api/v2/projects/map_to_workflow
- workflow_id
number
(required) Example: 1workflow id
- map
json
(required) Example: %7B1%3A+5%2C+2%3A+6%7Dmapping from task lists to workflow statuses
Generated by aglio on 24 Jul 2025