API Documentation

API Endpoint

Projects

Projects

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
Requestsreturns projects

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "644",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "1",
        "project_number": "1",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-04-19T06:07:47.000+02:00",
        "public_access": true,
        "time_on_tasks": true,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-04-19T06:07:47.190+02:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "948"
          }
        },
        "company": {
          "meta": {
            "included": false
          }
        },
        "project_manager": {
          "meta": {
            "included": false
          }
        },
        "last_actor": {
          "meta": {
            "included": false
          }
        },
        "workflow": {
          "meta": {
            "included": false
          }
        },
        "custom_field_people": {
          "meta": {
            "included": false
          }
        },
        "template_object": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "646",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "2",
        "project_number": "2",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-04-19T06:07:47.000+02:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-04-19T06:07:47.304+02:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "948"
          }
        },
        "company": {
          "meta": {
            "included": false
          }
        },
        "project_manager": {
          "meta": {
            "included": false
          }
        },
        "last_actor": {
          "meta": {
            "included": false
          }
        },
        "workflow": {
          "meta": {
            "included": false
          }
        },
        "custom_field_people": {
          "meta": {
            "included": false
          }
        },
        "template_object": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "647",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": "3",
        "project_number": "3",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": "2024-04-19T06:07:47.000+02:00",
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "created_at": "2024-04-19T06:07:47.333+02:00",
        "template": false,
        "custom_fields": null,
        "task_custom_fields_ids": null,
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "948"
          }
        },
        "company": {
          "meta": {
            "included": false
          }
        },
        "project_manager": {
          "meta": {
            "included": false
          }
        },
        "last_actor": {
          "meta": {
            "included": false
          }
        },
        "workflow": {
          "meta": {
            "included": false
          }
        },
        "custom_field_people": {
          "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 projects
GET/api/v2/projects

GET /api/v2/projects/1
Requestsreturns project

GET  /api/v2/projects/652

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "652",
    "type": "projects",
    "attributes": {
      "name": "test project",
      "number": "1",
      "project_number": "1",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:47.000+02:00",
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:47.911+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "950"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a project
GET/api/v2/projects/{id}

URI Parameters
HideShow
id
number (required) Example: 1

project id

POST /api/v2/projects
Requestscreates projectreturns error

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": "2365"
        }
      },
      "project_manager": {
        "data": {
          "type": "people",
          "id": "3169"
        }
      },
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "728"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "654",
    "type": "projects",
    "attributes": {
      "name": "test name",
      "number": "2",
      "project_number": "2",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:48.000+02:00",
      "public_access": false,
      "time_on_tasks": false,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:48.198+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "951"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "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": ""
    }
  }
}
Responses422
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 project
POST/api/v2/projects

URI Parameters
HideShow
name
string (required) Example: Name

name

project_manager_id
number (required) Example: 1

project manager id

company_id
number (required) Example: 1

company id

workflow_id
number (required) Example: 1

worfklow id

PATCH /api/v2/projects/1
Requestsupdates projectreturns errordoes not change workflow

PATCH  /api/v2/projects/659

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"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "659",
    "type": "projects",
    "attributes": {
      "name": "new name",
      "number": "1",
      "project_number": "1",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:49.000+02:00",
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:49.188+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "956"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/projects/660

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": ""
    }
  }
}
Responses422
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/661

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": 740
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "661",
    "type": "projects",
    "attributes": {
      "name": "test project",
      "number": "1",
      "project_number": "1",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:49.000+02:00",
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:49.565+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "958"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Update a project
PATCH/api/v2/projects/{id}

URI Parameters
HideShow
id
number (required) Example: 1

project id

PATCH /api/v2/projects/1/archive
Requestsarchives project

PATCH  /api/v2/projects/662/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "662",
    "type": "projects",
    "attributes": {
      "name": "test project",
      "number": "1",
      "project_number": "1",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:49.000+02:00",
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": "2024-04-19T06:07:49.000+02:00",
      "created_at": "2024-04-19T06:07:49.764+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "959"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Archives a project
PATCH/api/v2/projects/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

project id

PATCH /api/v2/projects/1/restore
Requestsrestores project

PATCH  /api/v2/projects/663/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "663",
    "type": "projects",
    "attributes": {
      "name": "test project",
      "number": "1",
      "project_number": "1",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:49.000+02:00",
      "public_access": true,
      "time_on_tasks": false,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:49.944+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "960"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Restores a project
PATCH/api/v2/projects/{id}/restore

URI Parameters
HideShow
id
number (required) Example: 1

project id

DELETE /api/v2/projects/1
Requestsdeletes project

DELETE  /api/v2/projects/664

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
Responses204
This response has no content.

Deletes a project
DELETE/api/v2/projects/{id}

URI Parameters
HideShow
id
number (required) Example: 1

project id

POST /api/v2/projects/copy
Requestscreates projectcreates projectcreates projectreturns errorcreates template projectcreates project

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": 665,
      "company_id": 2388,
      "project_type_id": 2,
      "copy_project_members": true,
      "copy_boards": true,
      "copy_task_lists": true,
      "copy_tasks": true,
      "copy_task_comments": false,
      "copy_task_subscribers": false,
      "copy_assignees": false,
      "copy_tags": false,
      "copy_estimate": true,
      "copy_views": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "666",
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "number": "2",
      "project_number": "2",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:50.000+02:00",
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:50.694+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "962"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "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": 667,
      "company_id": 2392,
      "project_type_id": 2,
      "copy_project_members": true,
      "copy_boards": true,
      "copy_task_lists": true,
      "copy_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
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "668",
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "number": "2",
      "project_number": "2",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:50.000+02:00",
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:52.185+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "963"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "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": 669,
      "project_type_id": 1,
      "copy_project_members": true,
      "copy_boards": true,
      "copy_task_lists": true,
      "copy_tasks": true,
      "copy_task_comments": false,
      "copy_task_subscribers": false,
      "copy_assignees": false,
      "copy_tags": false,
      "copy_estimate": true
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "670",
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "number": "2",
      "project_number": "2",
      "project_type_id": 1,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:52.000+02:00",
      "public_access": false,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:53.035+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "964"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "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": {}
  }
}
Responses422
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": 672,
      "company_id": 2399,
      "project_type_id": 2,
      "copy_project_members": true,
      "copy_boards": true,
      "copy_task_lists": true,
      "copy_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
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "673",
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "number": null,
      "project_number": null,
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:53.000+02:00",
      "public_access": true,
      "time_on_tasks": true,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:53.949+02:00",
      "template": true,
      "custom_fields": null,
      "description": "This is a description",
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "966"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "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": 674,
      "company_id": 2402,
      "project_type_id": 2,
      "copy_project_members": true,
      "copy_boards": true,
      "copy_task_lists": true,
      "copy_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
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "675",
    "type": "projects",
    "attributes": {
      "name": "This is a name",
      "number": "1",
      "project_number": "1",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:54.000+02:00",
      "public_access": true,
      "time_on_tasks": false,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:54.491+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "967"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Copies a project
POST/api/v2/projects/copy

PATCH /api/v2/projects/change_workflow
Requestschanges project workflow and maps tasksreturn errorreturn errorreturn errorreturn errorreturn error

PATCH  /api/v2/projects/676/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": {
        "860": 864,
        "861": 865,
        "862": 864
      }
    },
    "relationships": {
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "763"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "676",
    "type": "projects",
    "attributes": {
      "name": "test project",
      "number": "1",
      "project_number": "1",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:07:54.000+02:00",
      "public_access": true,
      "time_on_tasks": false,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:07:54.764+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "968"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/projects/687/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": "786"
        }
      }
    }
  }
}
Responses422
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/698/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": {
        "893": 897,
        "894": 898,
        "895": 897
      }
    },
    "relationships": {
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "0"
        }
      }
    }
  }
}
Responses422
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/709/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": "800"
        }
      }
    }
  }
}
Responses422
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/720/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": {
        "925": 929,
        "926": 930
      }
    },
    "relationships": {
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "812"
        }
      }
    }
  }
}
Responses422
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/731/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": {
        "941": 945,
        "942": "0",
        "943": 945
      }
    },
    "relationships": {
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "824"
        }
      }
    }
  }
}
Responses422
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 project
PATCH/api/v2/projects/change_workflow

URI Parameters
HideShow
workflow_id
number (required) Example: 1

workflow id

map
json (required) Example: %7B+1%3A+5%2C+2%3A+6+%7D

mapping from current workflow statuses to new workflow statuses

PATCH /api/v2/projects/map_to_workflow
Requestsmaps tasks from task lists to statusesreturns errorreturns errorreturns error

PATCH  /api/v2/projects/742/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": {
        "122": 960,
        "123": 961,
        "124": 959
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "742",
    "type": "projects",
    "attributes": {
      "name": "test project",
      "number": "1",
      "project_number": "1",
      "project_type_id": 2,
      "project_color_id": null,
      "last_activity_at": "2024-04-19T06:08:04.000+02:00",
      "public_access": true,
      "time_on_tasks": false,
      "tag_colors": {},
      "archived_at": null,
      "created_at": "2024-04-19T06:08:04.566+02:00",
      "template": false,
      "custom_fields": null,
      "task_custom_fields_ids": null,
      "sample_data": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "974"
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "project_manager": {
        "meta": {
          "included": false
        }
      },
      "last_actor": {
        "meta": {
          "included": false
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      },
      "custom_field_people": {
        "meta": {
          "included": false
        }
      },
      "template_object": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/projects/746/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": {}
  }
}
Responses422
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/750/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": 975,
        "128": 974
      }
    }
  }
}
Responses422
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/754/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": {
        "131": 985,
        "132": "0"
      }
    }
  }
}
Responses422
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 tasks
PATCH/api/v2/projects/map_to_workflow

URI Parameters
HideShow
workflow_id
number (required) Example: 1

workflow id

map
json (required) Example: %7B1%3A+5%2C+2%3A+6%7D

mapping from task lists to workflow statuses

Generated by aglio on 19 Apr 2024