{
"swagger": "2.0",
"info": {
"version": "",
"title": "Teamwork API V2",
"description": ""
},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
{
"name": "Account Details"
},
{
"name": "Project Templates"
},
{
"name": "Tasks"
},
{
"name": "Custom Fields"
}
],
"securityDefinitions": {
"YOUR_API_KEY": {
"type": "basic"
}
},
"paths": {
"/projects/api/v2/me.json": {
"get": {
"operationId": "GET_projects-api-v2-me-json",
"summary": "Get account details",
"tags": [
"Account Details"
],
"description": "**NOTE: This is a V2 endpoint. These endpoints can be used but are subject to change.**\n\nReturns your account details by calling me.json.\n\n---",
"parameters": [
{
"name": "getPermissions",
"in": "query",
"description": "To get permissions on your account.",
"type": "boolean",
"default": false
}
],
"responses": {
"default": {
"description": "",
"schema": {}
}
},
"security": [
{
"YOUR_API_KEY": []
}
]
}
},
"/projects/api/v2/projects/templates.json": {
"get": {
"operationId": "GET_projects-api-v2-projects-templates-json",
"summary": "Get Project Templates",
"tags": [
"Project Templates"
],
"description": "**NOTE: This is a V2 endpoint. These endpoints can be used but are subject to change.**\n\nReturns all project templates which were set up on the account. To create, update or delete a template, please see v1. ",
"parameters": [
{
"name": "searchTerm",
"in": "query",
"type": "string"
},
{
"name": "orderBy",
"in": "query",
"description": "Options: createdOn OR name",
"type": "string"
},
{
"name": "projectOwnerIds",
"in": "query",
"description": "Comma separated list of ID's",
"type": "string"
},
{
"name": "projectTagIds",
"in": "query",
"description": "Comma separated list of ID's",
"type": "string"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "object",
"properties": {
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"activePages": {
"type": "object",
"properties": {
"billing": {
"type": "boolean"
},
"comments": {
"type": "boolean"
},
"files": {
"type": "boolean"
},
"links": {
"type": "boolean"
},
"messages": {
"type": "boolean"
},
"milestones": {
"type": "boolean"
},
"notebooks": {
"type": "boolean"
},
"riskRegister": {
"type": "boolean"
},
"tasks": {
"type": "boolean"
},
"time": {
"type": "boolean"
}
}
},
"activeUserIsProjectAdmin": {
"type": "boolean"
},
"announcement": {
"type": "string"
},
"announcementHTML": {
"type": "string"
},
"category": {
"type": "object",
"properties": {
"color": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"isOwner": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
},
"createdOn": {
"type": "string"
},
"defaultPrivacy": {
"type": "string"
},
"defaults": {
"type": "object",
"properties": {
"privacy": {
"type": "string"
}
}
},
"description": {
"type": "string"
},
"directFileUploadsEnabled": {
"type": "boolean"
},
"filesAutoNewVersion": {
"type": "boolean"
},
"harvestTimersEnabled": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"integrations": {
"type": "object",
"properties": {
"microsoftConnectors": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"oneDriveBusiness": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"folder": {
"type": "string"
},
"folderName": {
"type": "string"
}
}
},
"sharepoint": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"folder": {
"type": "string"
},
"folderName": {
"type": "string"
}
}
},
"xero": {
"type": "object",
"properties": {
"baseCurrency": {
"type": "string"
},
"connected": {
"type": "boolean"
},
"countryCode": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"organisation": {
"type": "string"
}
}
}
}
},
"isProjectAdmin": {
"type": "boolean"
},
"lastChangedOn": {
"type": "string"
},
"lastWorkedOn": {
"type": "string"
},
"logo": {
"type": "string"
},
"logoFromCompany": {
"type": "boolean"
},
"milestones": {
"type": "object"
},
"minMaxAvailableDates": {
"type": "object",
"properties": {
"deadlinesFound": {
"type": "boolean"
},
"suggestedEndDate": {
"type": "string"
},
"suggestedStartDate": {
"type": "string"
}
}
},
"name": {
"type": "string"
},
"notifyEveryone": {
"type": "boolean"
},
"overviewStartPage": {
"type": "string"
},
"privacyEnabled": {
"type": "boolean"
},
"projectOwnerId": {
"type": "integer"
},
"replyByEmailEnabled": {
"type": "boolean"
},
"showAnnouncement": {
"type": "boolean"
},
"skipWeekends": {
"type": "boolean"
},
"starred": {
"type": "boolean"
},
"startPage": {
"type": "string"
},
"status": {
"type": "string"
},
"subStatus": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"projectId": {
"type": "integer"
}
}
}
},
"tasksStartPage": {
"type": "string"
},
"templateDateTargetDefault": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
}
},
"examples": {
"application/json": {
"projects": [
{
"activePages": {
"billing": true,
"comments": false,
"files": true,
"links": true,
"messages": true,
"milestones": true,
"notebooks": true,
"riskRegister": false,
"tasks": true,
"time": true
},
"activeUserIsProjectAdmin": false,
"announcement": "",
"announcementHTML": "",
"category": {
"color": "",
"id": 22610,
"name": "Testing - Proper"
},
"company": {
"id": 1,
"isOwner": true,
"name": "Owner Company"
},
"createdOn": "2019-07-01T09:04:30Z",
"defaultPrivacy": "open",
"defaults": {
"privacy": ""
},
"description": "Test Description",
"directFileUploadsEnabled": true,
"filesAutoNewVersion": false,
"harvestTimersEnabled": false,
"id": 360176,
"integrations": {
"microsoftConnectors": {
"enabled": false
},
"oneDriveBusiness": {
"account": "",
"enabled": false,
"folder": "root",
"folderName": "root"
},
"sharepoint": {
"account": "",
"enabled": false,
"folder": "root",
"folderName": "root"
},
"xero": {
"baseCurrency": "",
"connected": false,
"countryCode": "",
"enabled": false,
"organisation": ""
}
},
"isProjectAdmin": true,
"lastChangedOn": "2019-07-01T09:04:30Z",
"lastWorkedOn": "2019-07-01T09:04:30Z",
"logo": "https://s3.amazonaws.com/TWFiles/444268/companyLogo/tf_B318BF15-A2B4-B19C-D42AC4D9D9188ADB.674eec6cb9570b7ae89ab57c663b387f.gif",
"logoFromCompany": true,
"milestones": null,
"minMaxAvailableDates": {
"deadlinesFound": false,
"suggestedEndDate": "20190702",
"suggestedStartDate": "20190701"
},
"name": "Test Template",
"notifyEveryone": false,
"overviewStartPage": "default",
"privacyEnabled": false,
"projectOwnerId": 150381,
"replyByEmailEnabled": true,
"showAnnouncement": false,
"skipWeekends": false,
"starred": false,
"startPage": "projectoverview",
"status": "active",
"subStatus": "current",
"tags": [
{
"id": 1,
"name": "Management",
"color": "#4d4d4d",
"projectId": 0
}
],
"tasksStartPage": "list",
"templateDateTargetDefault": "start",
"type": "projects-template"
}
]
}
}
}
},
"security": [
{
"YOUR_API_KEY": []
}
]
}
},
"/projects/template.json": {},
"/projects/template/{TemplateID}.json": {
"parameters": [
{
"name": "TemplateID",
"in": "path",
"required": true,
"type": "string"
}
]
},
"/projects/api/v2/projects/{id}/predecessors.json": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"get": {
"operationId": "GET_projects-api-v2-projects-id-predecessors-json",
"summary": "Retrieve all Task Predecessors/Dependencies on a given Project",
"tags": [
"Tasks"
],
"description": "**NOTE: This is a V2 endpoint. These endpoints can be used but are subject to change.**\n\nReturns Predecessors tasks of tasks within the project specified by ID in the URL. A task which has predecessors cannot be completed unless they are first, so they are essentially blocking a task.\n\n- includeDependencies and onlyDependencies are mutually exclusive query options. By default predecessors within the project are returned, but using these switches dependencies of this project can be included or exclusively returned. These switches will only impact the response where a project has dependency/predecessor links with other projects.\n\n---",
"parameters": [
{
"name": "includeDependencies",
"in": "query",
"type": "boolean",
"default": false
},
{
"name": "onlyDependencies",
"in": "query",
"type": "boolean",
"default": false
},
{
"name": "onlyBasicFields",
"in": "query",
"type": "boolean",
"default": false,
"description": "When true, means a reduced set of fields are returned."
},
{
"name": "onlyActionable",
"in": "query",
"type": "boolean",
"default": false,
"description": "When true, only return results for active projects, tasklists and tasks"
},
{
"in": "path",
"name": "id",
"type": "integer",
"required": true,
"description": "ID of the Project to query"
},
{
"in": "query",
"name": "dataSet",
"type": "string",
"default": "none",
"description": "Relates to the type of data you want returned.\n* ?dataSet=all: returns the full task objects for each dependancy on the call.\n* ?dataSet=basic: returns only the task dependancy ids for the call"
},
{
"in": "query",
"name": "page",
"type": "string"
},
{
"in": "query",
"name": "pageSize",
"type": "string"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "object",
"properties": {
"STATUS": {
"type": "string"
}
}
},
"examples": {
"application/json": {
"STATUS": "OK",
"tasks": [
{
"depTaskId": 1,
"id": 2,
"name": "Task One",
"status": "Closed",
"type": "start",
"parentTaskId": 0,
"projectType": "normal"
}
]
}
}
}
},
"security": [
{
"YOUR_API_KEY": []
}
]
}
},
"/projects/api/v2/tasklists/{id}/taskids.json": {
"get": {
"responses": {
"200": {
"description": "",
"schema": {
"type": "object",
"properties": {
"STATUS": {
"type": "string"
},
"taskids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"examples": {
"application/json": {
"STATUS": "OK",
"taskids": [
76721768,
4538399,
97986383,
95598673,
36144098
]
}
}
}
},
"summary": "Get all Task IDs on a given Task List",
"operationId": "GET_projects-api-v2-tasklists-tasklist-id-taskids-json",
"tags": [
"Tasks"
],
"description": "**NOTE: This is a V2 endpoint. These endpoints can be used but are subject to change.**\n\nReturns the Task IDs of a Task List by using the the Task List ID in the URL.\n\nAdditional notes:
\n\n- This call uses pagination. 250 tasks per page.\n---",
"security": [
{
"YOUR_API_KEY": []
}
],
"parameters": [
{
"in": "query",
"name": "filter",
"type": "string",
"default": "anytime",
"allowEmptyValue": true,
"enum": [
"all",
"anytime",
"overdue",
"today",
"yesterday",
"tomorrow",
"thisweek",
"within7",
"within14",
"within30",
"within365",
"nodate",
"noduedate",
"started",
"nostartdate",
"completed",
"created",
"newTaskDefaults",
"hasDate"
]
},
{
"in": "query",
"name": "filterText",
"type": "array",
"items": {
"type": "string"
}
},
{
"in": "query",
"name": "responsiblePartyIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "creatorIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "ignoreStartDates",
"type": "boolean",
"default": false
},
{
"in": "query",
"name": "useStartDatesForTodaysTasks",
"type": "boolean"
},
{
"in": "query",
"name": "include",
"type": "string"
},
{
"in": "query",
"name": "includeToday",
"type": "boolean"
},
{
"in": "query",
"name": "includeBlockedTasks",
"type": "boolean"
},
{
"in": "query",
"name": "updatedAfterDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "completedAfterDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "completedBeforeDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "sort",
"type": "string",
"default": "\"manual\""
},
{
"in": "query",
"name": "sortOrder",
"type": "string",
"default": "asc"
},
{
"in": "query",
"name": "page",
"type": "integer"
},
{
"in": "query",
"name": "pageSize",
"type": "integer"
},
{
"in": "query",
"name": "offsetCount",
"type": "integer"
},
{
"in": "query",
"name": "startDate",
"type": "string",
"format": "date"
},
{
"in": "query",
"name": "endDate",
"type": "string",
"format": "date"
},
{
"in": "query",
"name": "showDeleted",
"type": "boolean"
},
{
"in": "query",
"name": "includeTasksFromDeletedLists",
"type": "boolean"
},
{
"in": "query",
"name": "deletedAfterDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "showCompletedLists",
"type": "boolean"
},
{
"in": "query",
"name": "includeCompletedSubtasks",
"type": "boolean"
},
{
"in": "query",
"name": "getSubTasks",
"type": "boolean",
"default": true
},
{
"in": "query",
"name": "includeCompletedTasks",
"type": "boolean"
},
{
"in": "query",
"name": "includeTaskId",
"type": "integer"
},
{
"in": "query",
"name": "projectIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "projectStatus",
"type": "string",
"default": "active"
},
{
"in": "query",
"name": "includeArchivedProjects",
"type": "boolean",
"default": false
},
{
"in": "query",
"name": "projectHealths",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "projectCategoryIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "projectCompanyIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "projectOwnerIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "projectTagIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "matchAllProjectTags",
"type": "boolean"
},
{
"in": "query",
"name": "onlyStarredProjects",
"type": "boolean"
},
{
"in": "query",
"name": "follower-ids",
"type": "array",
"items": {
"type": "string"
}
},
{
"in": "query",
"name": "tagIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "createdAfterDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "createdBeforeDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "onlyTasksWithTickets",
"type": "boolean"
},
{
"in": "query",
"name": "onlyTasksWithUnreadComments",
"type": "boolean"
},
{
"in": "query",
"name": "includeUntaggedTasks",
"type": "boolean"
},
{
"in": "query",
"name": "onlyUntaggedTasks",
"type": "boolean"
},
{
"in": "query",
"name": "priority",
"type": "string"
},
{
"in": "query",
"name": "excludeTagIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "onlyTasksWithEstimatedTime",
"type": "boolean"
},
{
"in": "query",
"name": "includeTasksWithoutDueDates",
"type": "boolean"
},
{
"in": "query",
"name": "assigneeCompanyIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "path",
"name": "id",
"type": "integer",
"required": true,
"description": "ID of Project to query"
}
]
},
"parameters": [
{
"name": "id",
"in": "path",
"type": "string",
"required": true
}
]
},
"/projects/api/v2/projects/{id}/taskids.json": {
"get": {
"responses": {
"200": {
"description": "",
"schema": {
"type": "object",
"properties": {
"STATUS": {
"type": "string"
},
"taskids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
},
"summary": "Get all Tasks IDs on a given Project",
"operationId": "GET_projects-api-v2-projects-id-taskids-json",
"tags": [
"Tasks"
],
"description": "**NOTE: This is a V2 endpoint. These endpoints can be used but are subject to change.**\n\nReturns the Task IDs of a Project by using the the Project ID in the URL.\n\nAdditional notes:
\n\n- This call uses pagination. 250 tasks per page.\n---",
"parameters": [
{
"in": "query",
"name": "filter",
"type": "string",
"default": "anytime",
"allowEmptyValue": true,
"enum": [
"all",
"anytime",
"overdue",
"today",
"yesterday",
"tomorrow",
"thisweek",
"within7",
"within14",
"within30",
"within365",
"nodate",
"noduedate",
"started",
"nostartdate",
"completed",
"created",
"newTaskDefaults",
"hasDate"
]
},
{
"in": "query",
"name": "filterText",
"type": "array",
"items": {
"type": "string"
}
},
{
"in": "query",
"name": "responsiblePartyIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "creatorIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "ignoreStartDates",
"type": "boolean",
"default": false
},
{
"in": "query",
"name": "useStartDatesForTodaysTasks",
"type": "boolean"
},
{
"in": "query",
"name": "include",
"type": "string"
},
{
"in": "query",
"name": "includeToday",
"type": "boolean"
},
{
"in": "query",
"name": "includeBlockedTasks",
"type": "boolean"
},
{
"in": "query",
"name": "updatedAfterDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "completedAfterDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "completedBeforeDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "sort",
"type": "string",
"default": "\"manual\""
},
{
"in": "query",
"name": "sortOrder",
"type": "string",
"default": "asc"
},
{
"in": "query",
"name": "page",
"type": "integer"
},
{
"in": "query",
"name": "pageSize",
"type": "integer"
},
{
"in": "query",
"name": "offsetCount",
"type": "integer"
},
{
"in": "query",
"name": "startDate",
"type": "string",
"format": "date"
},
{
"in": "query",
"name": "endDate",
"type": "string",
"format": "date"
},
{
"in": "query",
"name": "showDeleted",
"type": "boolean"
},
{
"in": "query",
"name": "includeTasksFromDeletedLists",
"type": "boolean"
},
{
"in": "query",
"name": "deletedAfterDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "showCompletedLists",
"type": "boolean"
},
{
"in": "query",
"name": "includeCompletedSubtasks",
"type": "boolean"
},
{
"in": "query",
"name": "getSubTasks",
"type": "boolean",
"default": true
},
{
"in": "query",
"name": "includeCompletedTasks",
"type": "boolean"
},
{
"in": "query",
"name": "includeTaskId",
"type": "integer"
},
{
"in": "query",
"name": "projectIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "projectStatus",
"type": "string",
"default": "active"
},
{
"in": "query",
"name": "includeArchivedProjects",
"type": "boolean",
"default": false
},
{
"in": "query",
"name": "projectHealths",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "projectCategoryIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "projectCompanyIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "projectOwnerIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "projectTagIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "matchAllProjectTags",
"type": "boolean"
},
{
"in": "query",
"name": "onlyStarredProjects",
"type": "boolean"
},
{
"in": "query",
"name": "follower-ids",
"type": "array",
"items": {
"type": "string"
}
},
{
"in": "query",
"name": "tagIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "createdAfterDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "createdBeforeDate",
"type": "string",
"format": "date-time"
},
{
"in": "query",
"name": "onlyTasksWithTickets",
"type": "boolean"
},
{
"in": "query",
"name": "onlyTasksWithUnreadComments",
"type": "boolean"
},
{
"in": "query",
"name": "includeUntaggedTasks",
"type": "boolean"
},
{
"in": "query",
"name": "onlyUntaggedTasks",
"type": "boolean"
},
{
"in": "query",
"name": "priority",
"type": "string"
},
{
"in": "query",
"name": "excludeTagIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "query",
"name": "onlyTasksWithEstimatedTime",
"type": "boolean"
},
{
"in": "query",
"name": "includeTasksWithoutDueDates",
"type": "boolean"
},
{
"in": "query",
"name": "assigneeCompanyIds",
"type": "array",
"items": {
"type": "integer"
}
},
{
"in": "path",
"name": "id",
"type": "integer",
"required": true,
"description": "ID of Project to query"
}
],
"security": [
{
"YOUR_API_KEY": []
}
]
},
"parameters": [
{
"name": "id",
"in": "path",
"type": "string",
"required": true
}
]
},
"/projects/api/v2/projects.json": {
"get": {
"responses": {
"200": {
"description": "",
"schema": {
"type": "object",
"properties": {
"STATUS": {
"type": "string"
},
"customFields": {
"type": "object",
"properties": {
"customFieldId": {
"type": "object",
"example": "100",
"description": "This contains the string value of the custom field id",
"properties": {
"id": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"entity": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"options": {
"type": "object"
},
"visibilities": {
"type": "array",
"items": {
"type": "object"
}
},
"isPrivate": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"createdByUserId": {
"type": "integer"
},
"updatedAt": {
"type": "string"
},
"updatedByUserId": {
"type": "integer"
},
"deleted": {
"type": "boolean"
},
"deletedAt": {
"type": "string"
},
"deletedByUserId": {
"type": "integer"
}
}
}
}
},
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"activePages": {
"type": "object",
"properties": {
"billing": {
"type": "boolean"
},
"comments": {
"type": "boolean"
},
"files": {
"type": "boolean"
},
"links": {
"type": "boolean"
},
"messages": {
"type": "boolean"
},
"milestones": {
"type": "boolean"
},
"notebooks": {
"type": "boolean"
},
"riskRegister": {
"type": "boolean"
},
"tasks": {
"type": "boolean"
},
"time": {
"type": "boolean"
}
}
},
"activeUserIsProjectAdmin": {
"type": "boolean"
},
"announcement": {
"type": "string"
},
"announcementHTML": {
"type": "string"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"isOwner": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
},
"createdOn": {
"type": "string"
},
"defaultPrivacy": {
"type": "string"
},
"defaults": {
"type": "object",
"properties": {
"privacy": {
"type": "string"
}
}
},
"description": {
"type": "string"
},
"directFileUploadsEnabled": {
"type": "boolean"
},
"filesAutoNewVersion": {
"type": "boolean"
},
"harvestTimersEnabled": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"integrations": {
"type": "object",
"properties": {
"onedrivebusiness": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"folder": {
"type": "string"
},
"folderName": {
"type": "string"
}
}
},
"sharepoint": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"folder": {
"type": "string"
},
"folderName": {
"type": "string"
}
}
},
"xero": {
"type": "object",
"properties": {
"baseCurrency": {
"type": "string"
},
"connected": {
"type": "boolean"
},
"countryCode": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"organisation": {
"type": "string"
}
}
}
}
},
"isOnBoardingProject": {
"type": "boolean"
},
"isProjectAdmin": {
"type": "boolean"
},
"isSampleProject": {
"type": "boolean"
},
"lastChangedOn": {
"type": "string"
},
"lastWorkedOn": {
"type": "string"
},
"logo": {
"type": "string"
},
"name": {
"type": "string"
},
"notifyEveryone": {
"type": "boolean"
},
"overviewStartPage": {
"type": "string"
},
"privacyEnabled": {
"type": "boolean"
},
"projectOwnerId": {
"type": "integer"
},
"replyByEmailEnabled": {
"type": "boolean"
},
"showAnnouncement": {
"type": "boolean"
},
"skipWeekends": {
"type": "boolean"
},
"starred": {
"type": "boolean"
},
"startPage": {
"type": "string"
},
"status": {
"type": "string"
},
"subStatus": {
"type": "string"
},
"tasksStartPage": {
"type": "string"
},
"type": {
"type": "string"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"customFieldId": {
"type": "integer"
},
"value": {
"type": "string"
}
}
}
}
}
}
}
}
},
"examples": {
"application/json": {
"STATUS": "consectetur anim Excepteur",
"customFields": {
"226": {
"id": -12744963,
"projectId": null,
"entity": "dolor",
"name": "aliquip quis",
"description": "laborum in reprehenderit sint ipsum",
"type": "nostrud aute",
"options": null,
"visibilities": [
{},
{},
{},
{}
],
"isPrivate": true,
"required": true,
"createdAt": "dolor in laboris nisi",
"createdByUserId": -93035778,
"updatedAt": "Ut est sit dolor nisi",
"updatedByUserId": -42929281,
"deleted": false,
"deletedAt": null,
"deletedByUserId": null
}
},
"projects": [
{
"activePages": {
"billing": false,
"comments": false,
"files": false,
"links": false,
"messages": true,
"milestones": false,
"notebooks": true,
"riskRegister": false,
"tasks": false,
"time": true
},
"activeUserIsProjectAdmin": true,
"announcement": "consequat sit ut do aliqua",
"announcementHTML": "dolor",
"company": {
"id": 42834988,
"isOwner": true,
"name": "id ut reprehenderit qui cupidatat"
},
"createdOn": "sunt Lorem laboris",
"defaultPrivacy": "non aliquip et culpa",
"defaults": {
"privacy": "enim dolore reprehenderit tempor adipisicing"
},
"description": "cillum pariatur eiusmod dolor aliquip",
"directFileUploadsEnabled": true,
"filesAutoNewVersion": true,
"harvestTimersEnabled": true,
"id": 64167044,
"integrations": {
"onedrivebusiness": {
"account": "sit",
"enabled": false,
"folder": "velit ut exercitation",
"folderName": "ut non Ut qui"
},
"sharepoint": {
"account": "aute adipisicing incididunt laboris labore",
"enabled": true,
"folder": "ut Duis officia",
"folderName": "commodo non in"
},
"xero": {
"baseCurrency": "ut",
"connected": false,
"countryCode": "nulla ullamco dolore",
"enabled": true,
"organisation": "amet consequat"
}
},
"isOnBoardingProject": true,
"isProjectAdmin": false,
"isSampleProject": true,
"lastChangedOn": "nostrud deserunt aliquip",
"lastWorkedOn": "Lorem ut minim",
"logo": "labore enim in proident id",
"name": "dolore voluptate Duis Ut amet",
"notifyEveryone": true,
"overviewStartPage": "esse anim et tempor",
"privacyEnabled": false,
"projectOwnerId": -21849218,
"replyByEmailEnabled": true,
"showAnnouncement": true,
"skipWeekends": true,
"starred": false,
"startPage": "laboris commodo",
"status": "irure et",
"subStatus": "velit in culpa quis deserunt",
"tasksStartPage": "amet veniam ullamco",
"type": "est",
"customFields": [
{
"id": -13512400,
"customFieldId": 42027296,
"value": "est"
},
{
"id": -64729361,
"customFieldId": -86428110,
"value": "dolore aute officia amet sint"
}
]
},
{
"activePages": {
"billing": false,
"comments": false,
"files": true,
"links": true,
"messages": true,
"milestones": false,
"notebooks": false,
"riskRegister": false,
"tasks": true,
"time": true
},
"activeUserIsProjectAdmin": true,
"announcement": "Duis dolor",
"announcementHTML": "mollit Lorem sit ea",
"company": {
"id": -45263927,
"isOwner": true,
"name": "ad non in est in"
},
"createdOn": "minim",
"defaultPrivacy": "proident",
"defaults": {
"privacy": "do officia"
},
"description": "in non",
"directFileUploadsEnabled": true,
"filesAutoNewVersion": false,
"harvestTimersEnabled": false,
"id": 66910303,
"integrations": {
"onedrivebusiness": {
"account": "nisi occaeca",
"enabled": false,
"folder": "Ut eu",
"folderName": "cupidatat aliqua et"
},
"sharepoint": {
"account": "est minim aliquip tempor",
"enabled": true,
"folder": "veniam ex dolore",
"folderName": "id esse ut"
},
"xero": {
"baseCurrency": "aliqua",
"connected": true,
"countryCode": "no",
"enabled": false,
"organisation": "aute dolore"
}
},
"isOnBoardingProject": true,
"isProjectAdmin": true,
"isSampleProject": true,
"lastChangedOn": "labore ipsum aliqua",
"lastWorkedOn": "in non pariatur",
"logo": "eiusmod",
"name": "mollit proident aliqua et Lorem",
"notifyEveryone": true,
"overviewStartPage": "quis eu aute pariatur Ut",
"privacyEnabled": false,
"projectOwnerId": -30947304,
"replyByEmailEnabled": true,
"showAnnouncement": true,
"skipWeekends": true,
"starred": true,
"startPage": "Lorem minim eu Excepteur",
"status": "adipisicing",
"subStatus": "cillum in",
"tasksStartPage": "ea enim in laborum",
"type": "est velit sunt fugiat",
"customFields": [
{
"id": 19486905,
"customFieldId": -41779248,
"value": "minim"
},
{
"id": -54540738,
"customFieldId": 61768953,
"value": "tempor pariatur consectetur in"
}
]
},
{
"activePages": {
"billing": false,
"comments": false,
"files": true,
"links": true,
"messages": false,
"milestones": true,
"notebooks": true,
"riskRegister": true,
"tasks": true,
"time": true
},
"activeUserIsProjectAdmin": false,
"announcement": "a",
"announcementHTML": "sunt ut labor",
"company": {
"id": 10392829,
"isOwner": true,
"name": "fugiat"
},
"createdOn": "exercitation",
"defaultPrivacy": "aliqua quis dolore laboris ipsum",
"defaults": {
"privacy": "la"
},
"description": "eu laborum",
"directFileUploadsEnabled": false,
"filesAutoNewVersion": true,
"harvestTimersEnabled": false,
"id": 68336865,
"integrations": {
"onedrivebusiness": {
"account": "ex non in exercitation anim",
"enabled": false,
"folder": "labore",
"folderName": "incididunt sit commodo in"
},
"sharepoint": {
"account": "magna",
"enabled": true,
"folder": "minim culpa elit",
"folderName": "nostrud cupid"
},
"xero": {
"baseCurrency": "aliqua nulla in amet sint",
"connected": true,
"countryCode": "velit quis ea",
"enabled": true,
"organisation": "commodo do"
}
},
"isOnBoardingProject": true,
"isProjectAdmin": false,
"isSampleProject": true,
"lastChangedOn": "ad ut ut consectetur",
"lastWorkedOn": "aliqua sit",
"logo": "Ut enim aute aliquip",
"name": "consectetur in",
"notifyEveryone": true,
"overviewStartPage": "qui id ex si",
"privacyEnabled": true,
"projectOwnerId": -5673037,
"replyByEmailEnabled": true,
"showAnnouncement": false,
"skipWeekends": false,
"starred": true,
"startPage": "voluptate est",
"status": "fugiat laborum anim proident adipisicing",
"subStatus": "in est ipsum",
"tasksStartPage": "exercitation Ut",
"type": "minim cillum Excepteur ex in",
"customFields": [
{
"id": -89829001,
"customFieldId": 84990855,
"value": "Duis dolore"
},
{
"id": -72575073,
"customFieldId": -4426617,
"value": "pariatur"
},
{
"id": -75598110,
"customFieldId": 41900117,
"value": "ea laboris ullamco ipsum volu"
},
{
"id": -4219690,
"customFieldId": 91575558,
"value": "magna ipsum"
}
]
},
{
"activePages": {
"billing": true,
"comments": false,
"files": true,
"links": false,
"messages": true,
"milestones": false,
"notebooks": false,
"riskRegister": true,
"tasks": false,
"time": true
},
"activeUserIsProjectAdmin": true,
"announcement": "quis ea dolor ut Duis",
"announcementHTML": "velit commodo quis",
"company": {
"id": 80140804,
"isOwner": false,
"name": "officia Lorem"
},
"createdOn": "ut nisi",
"defaultPrivacy": "cillum Ut anim enim laborum",
"defaults": {
"privacy": "eu Ut consectetur dolor mollit"
},
"description": "sit laboris aute sed",
"directFileUploadsEnabled": false,
"filesAutoNewVersion": false,
"harvestTimersEnabled": true,
"id": 85024266,
"integrations": {
"onedrivebusiness": {
"account": "consequat",
"enabled": true,
"folder": "culpa proident deserunt velit dolor",
"folderName": "qui"
},
"sharepoint": {
"account": "ex",
"enabled": false,
"folder": "anim velit voluptate sint fugiat",
"folderName": "reprehende"
},
"xero": {
"baseCurrency": "dolore est Duis",
"connected": true,
"countryCode": "esse nisi sint",
"enabled": true,
"organisation": "sunt consectetur ut id et"
}
},
"isOnBoardingProject": false,
"isProjectAdmin": false,
"isSampleProject": true,
"lastChangedOn": "nostrud non sed",
"lastWorkedOn": "enim mollit",
"logo": "magna id elit",
"name": "dolore Duis sunt eu reprehenderit",
"notifyEveryone": true,
"overviewStartPage": "cupidatat ad",
"privacyEnabled": true,
"projectOwnerId": -69478575,
"replyByEmailEnabled": false,
"showAnnouncement": false,
"skipWeekends": true,
"starred": false,
"startPage": "consequat Excepteur",
"status": "ut magna non Excepteur consequat",
"subStatus": "voluptate do occaecat cillum",
"tasksStartPage": "non elit aliquip",
"type": "pariatur in",
"customFields": [
{
"id": -66941344,
"customFieldId": -26109968,
"value": "deserunt et elit"
},
{
"id": 14084788,
"customFieldId": -4591848,
"value": "Duis magna irure"
},
{
"id": 33150571,
"customFieldId": -67917169,
"value": "nostrud incididunt"
},
{
"id": -34982133,
"customFieldId": -20594265,
"value": "deserunt qui commodo ad"
}
]
}
]
}
}
}
},
"parameters": [
{
"in": "query",
"name": "page",
"type": "number"
},
{
"in": "query",
"name": "pageSize",
"type": "number"
},
{
"in": "query",
"name": "includeCustomFields",
"type": "boolean",
"default": false,
"required": true
}
],
"summary": "Get Custom Fields on projects",
"description": "Getting a list of projects with their custom fields requires you to pass in **?includeCustomFields=true**. \n\nA list of projects will be returned along with the custom fields associated with them. This is a paged API with pagination set at 50. To get the next page, you must pass in **page** parameter. \n\nIf a project doesn't have any custom fields set, project.customFields is omitted from the response, not null.\n\n**Please note:** The V1 /projects.json endpoint does not support includeCustomFields=true, you must use this V2 API.\n",
"tags": [
"Custom Fields"
]
}
},
"/projects/api/v2/tasks.json": {
"get": {
"responses": {
"200": {
"description": "",
"schema": {
"type": "object",
"properties": {
"STATUS": {
"type": "string"
},
"tasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"priority": {
"type": "string"
},
"status": {
"type": "string"
},
"parentTaskId": {
"type": "integer"
},
"description": {
"type": "string"
},
"canViewEstTime": {
"type": "boolean"
},
"updatedBy": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"avatarUrl": {
"type": "string"
}
}
},
"createdBy": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"avatarUrl": {
"type": "string"
}
}
},
"dateCreated": {
"type": "string"
},
"dateChanged": {
"type": "string"
},
"dateLastModified": {
"type": "string"
},
"hasFollowers": {
"type": "boolean"
},
"hasLoggedTime": {
"type": "boolean"
},
"hasReminders": {
"type": "boolean"
},
"hasRemindersForUser": {
"type": "boolean"
},
"hasRelativeReminders": {
"type": "boolean"
},
"hasTemplateReminders": {
"type": "boolean"
},
"hasTickets": {
"type": "boolean"
},
"isPrivate": {
"type": "boolean"
},
"installationId": {
"type": "integer"
},
"privacyIsInherited": {
"type": "boolean"
},
"lockdownId": {
"type": "integer"
},
"numMinutesLogged": {
"type": "integer"
},
"numActiveSubTasks": {
"type": "integer"
},
"numAttachments": {
"type": "integer"
},
"numComments": {
"type": "integer"
},
"numCommentsRead": {
"type": "integer"
},
"numCompletedSubTasks": {
"type": "integer"
},
"numDependencies": {
"type": "integer"
},
"numEstMins": {
"type": "integer"
},
"numPredecessors": {
"type": "integer"
},
"position": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"startDate": {
"type": "string"
},
"dueDate": {
"type": "string"
},
"dueDateFromMilestone": {
"type": "boolean"
},
"taskListId": {
"type": "integer"
},
"progress": {
"type": "integer"
},
"crmDealIds": {
"type": "integer"
},
"followingChanges": {
"type": "boolean"
},
"followingComments": {
"type": "boolean"
},
"changeFollowerIds": {
"type": "string"
},
"commentFollowerIds": {
"type": "string"
},
"teamsFollowingChanges": {
"type": "boolean"
},
"teamsFollowingComments": {
"type": "boolean"
},
"companiesFollowingChanges": {
"type": "boolean"
},
"companiesFollowingComments": {
"type": "boolean"
},
"order": {
"type": "integer"
},
"canComplete": {
"type": "boolean"
},
"canEdit": {
"type": "boolean"
},
"canLogTime": {
"type": "boolean"
},
"canAddSubtasks": {
"type": "boolean"
},
"placeholder": {
"type": "boolean"
},
"DLM": {
"type": "integer"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"customFieldId": {
"type": "integer"
},
"value": {
"type": "integer"
}
}
}
},
"assignedTo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
}
}
}
}
}
},
"customFields": {
"type": "object",
"properties": {
"customFieldId": {
"type": "object",
"example": "100",
"description": "This contains the string value of the custom field Id.",
"properties": {
"id": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"entity": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"options": {
"type": "object"
},
"visibilities": {
"type": "array",
"items": {
"type": "object"
}
},
"isPrivate": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"createdByUserId": {
"type": "integer"
},
"updatedAt": {
"type": "string"
},
"updatedByUserId": {
"type": "integer"
},
"deleted": {
"type": "boolean"
},
"deletedAt": {
"type": "string"
},
"deletedByUserId": {
"type": "integer"
}
}
}
}
}
}
},
"examples": {
"application/json": {
"STATUS": "et eu incididunt ad",
"tasks": [
{
"id": -30876907,
"name": "esse",
"priority": "dolor enim cillum laborum",
"status": "anim nostrud velit",
"parentTaskId": 65689390,
"description": "in commodo deserunt",
"canViewEstTime": false,
"updatedBy": {
"id": 90755783,
"firstName": "dolore eu voluptate Lorem",
"lastName": "ea nulla ut",
"avatarUrl": "in est cillum"
},
"createdBy": {
"id": -63423832,
"firstName": "aute et Duis qui",
"lastName": "amet in Lorem aliqua",
"avatarUrl": "anim ex velit"
},
"dateCreated": "labore cupidatat cillum mollit",
"dateChanged": "consectetur",
"dateLastModified": "in",
"hasFollowers": true,
"hasLoggedTime": true,
"hasReminders": true,
"hasRemindersForUser": true,
"hasRelativeReminders": true,
"hasTemplateReminders": false,
"hasTickets": true,
"isPrivate": false,
"installationId": -73223331,
"privacyIsInherited": true,
"lockdownId": -89342544,
"numMinutesLogged": -73851571,
"numActiveSubTasks": -22514396,
"numAttachments": -93026378,
"numComments": -18317801,
"numCommentsRead": 63503634,
"numCompletedSubTasks": 61995873,
"numDependencies": -33112273,
"numEstMins": -2396751,
"numPredecessors": -89316491,
"position": -73123450,
"projectId": -44577583,
"startDate": null,
"dueDate": null,
"dueDateFromMilestone": false,
"taskListId": -2703419,
"progress": 96513804,
"crmDealIds": null,
"followingChanges": false,
"followingComments": true,
"changeFollowerIds": "occaecat ut irure",
"commentFollowerIds": "deserunt",
"teamsFollowingChanges": null,
"teamsFollowingComments": null,
"companiesFollowingChanges": null,
"companiesFollowingComments": null,
"order": 88190422,
"canComplete": false,
"canEdit": true,
"canLogTime": true,
"canAddSubtasks": true,
"placeholder": false,
"DLM": -48313217,
"customFields": [
{
"id": -84410843,
"customFieldId": -47631168,
"value": 20167313
},
{
"id": -81046166,
"customFieldId": -44086685,
"value": -49826726
},
{
"id": 36796972,
"customFieldId": -77597124,
"value": -94221014
},
{
"id": 89240035,
"customFieldId": 34555003,
"value": 25581105
}
],
"assignedTo": [
{
"id": 55357878,
"firstName": "veniam sit in officia",
"lastName": "reprehenderit culpa cillum ullamco"
},
{
"id": -84848117,
"firstName": "irure",
"lastName": "ut officia commodo do dolore"
},
{
"id": -12475963,
"firstName": "in do sint deserunt",
"lastName": "sunt"
}
]
},
{
"id": -55455173,
"name": "aliqua veniam officia",
"priority": "nisi dolore enim incididunt anim",
"status": "cillum anim ad",
"parentTaskId": -97783333,
"description": "exercitatio",
"canViewEstTime": false,
"updatedBy": {
"id": -13755139,
"firstName": "occaecat reprehenderit",
"lastName": "officia veniam pariatur mollit esse",
"avatarUrl": "ipsum laborum ex cillum sunt"
},
"createdBy": {
"id": -93874443,
"firstName": "do",
"lastName": "ex anim",
"avatarUrl": "veniam nisi ut"
},
"dateCreated": "elit culp",
"dateChanged": "consectetur sint esse",
"dateLastModified": "in laborum",
"hasFollowers": false,
"hasLoggedTime": true,
"hasReminders": false,
"hasRemindersForUser": true,
"hasRelativeReminders": true,
"hasTemplateReminders": false,
"hasTickets": false,
"isPrivate": true,
"installationId": -6631288,
"privacyIsInherited": true,
"lockdownId": 62651997,
"numMinutesLogged": 78296554,
"numActiveSubTasks": -85367158,
"numAttachments": 73471058,
"numComments": 15265736,
"numCommentsRead": 96602567,
"numCompletedSubTasks": 49760131,
"numDependencies": -75854744,
"numEstMins": -55904059,
"numPredecessors": -26204700,
"position": 97480523,
"projectId": 25673783,
"startDate": null,
"dueDate": null,
"dueDateFromMilestone": false,
"taskListId": -83889359,
"progress": 46066939,
"crmDealIds": null,
"followingChanges": true,
"followingComments": true,
"changeFollowerIds": "non sed commodo Ut amet",
"commentFollowerIds": "in",
"teamsFollowingChanges": null,
"teamsFollowingComments": null,
"companiesFollowingChanges": null,
"companiesFollowingComments": null,
"order": -95668171,
"canComplete": true,
"canEdit": false,
"canLogTime": true,
"canAddSubtasks": false,
"placeholder": false,
"DLM": 45842384,
"customFields": [
{
"id": -35671732,
"customFieldId": 29558474,
"value": -95166981
},
{
"id": 61035140,
"customFieldId": -42157941,
"value": -57039423
},
{
"id": -29390138,
"customFieldId": 53229964,
"value": 6755625
}
],
"assignedTo": [
{
"id": 85558445,
"firstName": "aliqua esse",
"lastName": "mollit consequat tempor qui Duis"
},
{
"id": -1173978,
"firstName": "aute laborum",
"lastName": "sint in ut eu"
}
]
},
{
"id": -70989477,
"name": "consequa",
"priority": "Lorem ex in incididunt minim",
"status": "culpa quis aliquip labore eiusmod",
"parentTaskId": 69822609,
"description": "eiusmod cupidatat occaecat non",
"canViewEstTime": true,
"updatedBy": {
"id": 14232736,
"firstName": "voluptate incididunt ut non ",
"lastName": "incididunt ut conse",
"avatarUrl": "commodo cillum eu"
},
"createdBy": {
"id": 2067391,
"firstName": "ex ipsum deserunt",
"lastName": "co",
"avatarUrl": "fugiat"
},
"dateCreated": "sed voluptate",
"dateChanged": "eiusmod sunt",
"dateLastModified": "velit ex",
"hasFollowers": false,
"hasLoggedTime": false,
"hasReminders": false,
"hasRemindersForUser": true,
"hasRelativeReminders": true,
"hasTemplateReminders": false,
"hasTickets": true,
"isPrivate": false,
"installationId": 43014222,
"privacyIsInherited": true,
"lockdownId": 93093884,
"numMinutesLogged": -89494340,
"numActiveSubTasks": -16123451,
"numAttachments": -9226134,
"numComments": -69217547,
"numCommentsRead": -77963236,
"numCompletedSubTasks": -55565484,
"numDependencies": 46023670,
"numEstMins": 79073933,
"numPredecessors": -29841305,
"position": -36797562,
"projectId": 92800393,
"startDate": null,
"dueDate": null,
"dueDateFromMilestone": true,
"taskListId": -87532,
"progress": -29021202,
"crmDealIds": null,
"followingChanges": false,
"followingComments": false,
"changeFollowerIds": "fugiat culpa dolor",
"commentFollowerIds": "dolore est cupidatat Ut",
"teamsFollowingChanges": null,
"teamsFollowingComments": null,
"companiesFollowingChanges": null,
"companiesFollowingComments": null,
"order": -81023671,
"canComplete": false,
"canEdit": true,
"canLogTime": false,
"canAddSubtasks": true,
"placeholder": true,
"DLM": 30525117,
"customFields": [
{
"id": -64898528,
"customFieldId": -59961287,
"value": -88924506
},
{
"id": -13499040,
"customFieldId": -23418930,
"value": 36749484
},
{
"id": 65656782,
"customFieldId": 11140742,
"value": -27830993
},
{
"id": -81846713,
"customFieldId": -20362411,
"value": 6413000
},
{
"id": -30477597,
"customFieldId": 97980050,
"value": -98639414
}
],
"assignedTo": [
{
"id": 45448768,
"firstName": "voluptate in",
"lastName": "ullamco veniam sint dolore est"
},
{
"id": 4898405,
"firstName": "ali",
"lastName": "in reprehenderit proident tempor incididunt"
}
]
},
{
"id": -30612062,
"name": "incididunt id ex",
"priority": "pariatur voluptate esse labore",
"status": "Ut consectetur",
"parentTaskId": 69130575,
"description": "et esse sint",
"canViewEstTime": false,
"updatedBy": {
"id": -88578464,
"firstName": "id",
"lastName": "Excepteur Duis",
"avatarUrl": "culpa sed in"
},
"createdBy": {
"id": 52892036,
"firstName": "incididunt et Excepteur",
"lastName": "commodo officia pariatur",
"avatarUrl": "eiusmod deserunt sint"
},
"dateCreated": "id",
"dateChanged": "enim Excepteur cupidatat sit dolor",
"dateLastModified": "est quis Ut amet",
"hasFollowers": false,
"hasLoggedTime": true,
"hasReminders": true,
"hasRemindersForUser": false,
"hasRelativeReminders": false,
"hasTemplateReminders": true,
"hasTickets": false,
"isPrivate": false,
"installationId": 79748500,
"privacyIsInherited": true,
"lockdownId": 58480514,
"numMinutesLogged": -53218792,
"numActiveSubTasks": 59425089,
"numAttachments": 19355079,
"numComments": 25051052,
"numCommentsRead": 24804937,
"numCompletedSubTasks": -5493176,
"numDependencies": 33148917,
"numEstMins": 61810528,
"numPredecessors": 36968092,
"position": -50619296,
"projectId": -17500479,
"startDate": null,
"dueDate": null,
"dueDateFromMilestone": false,
"taskListId": -72089367,
"progress": 78888458,
"crmDealIds": null,
"followingChanges": false,
"followingComments": true,
"changeFollowerIds": "ut eiusmod",
"commentFollowerIds": "laboris qui nulla",
"teamsFollowingChanges": null,
"teamsFollowingComments": null,
"companiesFollowingChanges": null,
"companiesFollowingComments": null,
"order": 32056972,
"canComplete": true,
"canEdit": true,
"canLogTime": false,
"canAddSubtasks": false,
"placeholder": true,
"DLM": -8530089,
"customFields": [
{
"id": -8784334,
"customFieldId": 17510819,
"value": -93713418
},
{
"id": -98017836,
"customFieldId": -76982,
"value": 91463234
}
],
"assignedTo": [
{
"id": -93778669,
"firstName": "ad irure tempor nostrud mollit",
"lastName": "consequat aliqua dolore"
},
{
"id": -26089010,
"firstName": "anim",
"lastName": "anim"
},
{
"id": -58709646,
"firstName": "ea dolore dolor",
"lastName": "incididunt Duis fugiat deserunt"
},
{
"id": -66916252,
"firstName": "magna fugiat est exercitation Duis",
"lastName": "laborum qui eiusmod dolor commodo"
}
]
},
{
"id": 8130262,
"name": "Lorem ea",
"priority": "dolor cupidatat cillum sit",
"status": "sed eiusmod nisi",
"parentTaskId": -80911011,
"description": "sint",
"canViewEstTime": false,
"updatedBy": {
"id": 5179396,
"firstName": "deserun",
"lastName": "qui",
"avatarUrl": "officia consequat Excepteur dolore laboris"
},
"createdBy": {
"id": -12994127,
"firstName": "sed Lorem",
"lastName": "Duis cupidatat ea quis culpa",
"avatarUrl": "do"
},
"dateCreated": "eu non",
"dateChanged": "aute veniam voluptate",
"dateLastModified": "el",
"hasFollowers": false,
"hasLoggedTime": false,
"hasReminders": false,
"hasRemindersForUser": true,
"hasRelativeReminders": false,
"hasTemplateReminders": true,
"hasTickets": true,
"isPrivate": false,
"installationId": -29340726,
"privacyIsInherited": true,
"lockdownId": 38389427,
"numMinutesLogged": 25762204,
"numActiveSubTasks": -83334496,
"numAttachments": -91132756,
"numComments": -10931710,
"numCommentsRead": 67425381,
"numCompletedSubTasks": -25389977,
"numDependencies": -8026005,
"numEstMins": 666039,
"numPredecessors": -89459536,
"position": 16353753,
"projectId": 52719213,
"startDate": null,
"dueDate": null,
"dueDateFromMilestone": true,
"taskListId": 83925423,
"progress": 73511028,
"crmDealIds": null,
"followingChanges": true,
"followingComments": false,
"changeFollowerIds": "fugiat do deserunt",
"commentFollowerIds": "cillum",
"teamsFollowingChanges": null,
"teamsFollowingComments": null,
"companiesFollowingChanges": null,
"companiesFollowingComments": null,
"order": 86814248,
"canComplete": false,
"canEdit": true,
"canLogTime": true,
"canAddSubtasks": true,
"placeholder": false,
"DLM": 11158623,
"customFields": [
{
"id": -24279015,
"customFieldId": 24963546,
"value": -51823700
}
],
"assignedTo": [
{
"id": 68048627,
"firstName": "sed tempor velit",
"lastName": "est"
},
{
"id": 75241700,
"firstName": "dolore magna",
"lastName": "sunt nisi ut labore anim"
},
{
"id": 51713414,
"firstName": "pariatur in",
"lastName": "cillum velit"
}
]
}
],
"customFields": {
"199": {
"id": 10657864,
"projectId": -42925577,
"entity": "proident aute in",
"name": "ullamco culpa in Lorem",
"description": "ut anim eiusmod",
"type": "dolor ut ut in eu",
"options": null,
"visibilities": [
{},
{},
{}
],
"isPrivate": false,
"required": true,
"createdAt": "in exercitation ex",
"createdByUserId": -27646224,
"updatedAt": "occaecat",
"updatedByUserId": -54299812,
"deleted": false,
"deletedAt": null,
"deletedByUserId": null
},
"200": {
"id": 27562749,
"projectId": -74012048,
"entity": "occaecat ut consequat voluptate",
"name": "dolor mollit",
"description": "anim enim",
"type": "dolore laboris sunt aliquip",
"options": {
"choices": [
{
"value": "id dolor et",
"color": "proident velit"
}
]
},
"visibilities": [
{},
{},
{}
],
"isPrivate": true,
"required": true,
"createdAt": "aliqua",
"createdByUserId": -26281839,
"updatedAt": "l",
"updatedByUserId": 11282572,
"deleted": true,
"deletedAt": null,
"deletedByUserId": null
},
"201": {
"id": 35716951,
"projectId": 67716567,
"entity": "deserunt cupidatat nulla",
"name": "laborum",
"description": "ut mollit enim",
"type": "ipsum ut",
"options": null,
"visibilities": [
{}
],
"isPrivate": true,
"required": false,
"createdAt": "velit v",
"createdByUserId": -20061162,
"updatedAt": "ex ipsum",
"updatedByUserId": -86606101,
"deleted": false,
"deletedAt": null,
"deletedByUserId": null
},
"202": {
"id": 37585326,
"projectId": -7681504,
"entity": "non ad dolor",
"name": "commodo do laborum",
"description": "fugiat",
"type": "labore",
"options": null,
"visibilities": [
{},
{},
{}
],
"isPrivate": false,
"required": false,
"createdAt": "a",
"createdByUserId": 41509891,
"updatedAt": "aliqua",
"updatedByUserId": 75801173,
"deleted": true,
"deletedAt": null,
"deletedByUserId": null
}
}
}
}
}
},
"summary": "Get Custom Fields on tasks",
"description": "Getting a list of tasks with their custom fields requires you to pass in **?includeCustomFields=true**. \n\nA list of tasks will be returned along with the custom fields associated with them. This is a paged API with pagination set at 50. To get the next page, you must pass in **page** parameter. \n\nIf a task doesn't have any custom fields set, tasks.customFields is omitted from the response, not null.\n\n**Please note:** The V1 /tasks.json endpoint does not support includeCustomFields=true, you must use this V2 API.\n",
"tags": [
"Custom Fields"
],
"parameters": [
{
"in": "query",
"name": "page",
"type": "number"
},
{
"in": "query",
"name": "pageSize",
"type": "number",
"default": "50"
},
{
"in": "query",
"name": "includeCustomFields",
"type": "boolean",
"default": false,
"required": true
}
]
}
},
"/projects/api/v2/tasks/{taskId}.json": {
"get": {
"responses": {
"200": {
"description": "",
"schema": {
"type": "object",
"properties": {
"STATUS": {
"type": "string"
},
"task": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"priority": {
"type": "string"
},
"status": {
"type": "string"
},
"parentTaskId": {
"type": "integer"
},
"description": {
"type": "string"
},
"canViewEstTime": {
"type": "boolean"
},
"updatedBy": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"avatarUrl": {
"type": "string"
}
}
},
"createdBy": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"avatarUrl": {
"type": "string"
}
}
},
"dateCreated": {
"type": "string"
},
"dateChanged": {
"type": "string"
},
"dateLastModified": {
"type": "string"
},
"hasFollowers": {
"type": "boolean"
},
"hasLoggedTime": {
"type": "boolean"
},
"hasReminders": {
"type": "boolean"
},
"hasRemindersForUser": {
"type": "boolean"
},
"hasRelativeReminders": {
"type": "boolean"
},
"hasTemplateReminders": {
"type": "boolean"
},
"hasTickets": {
"type": "boolean"
},
"isPrivate": {
"type": "boolean"
},
"installationId": {
"type": "integer"
},
"privacyIsInherited": {
"type": "boolean"
},
"lockdownId": {
"type": "integer"
},
"numMinutesLogged": {
"type": "integer"
},
"numActiveSubTasks": {
"type": "integer"
},
"numAttachments": {
"type": "integer"
},
"numComments": {
"type": "integer"
},
"numCommentsRead": {
"type": "integer"
},
"numCompletedSubTasks": {
"type": "integer"
},
"numDependencies": {
"type": "integer"
},
"numEstMins": {
"type": "integer"
},
"numPredecessors": {
"type": "integer"
},
"position": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"startDate": {
"type": "string"
},
"dueDate": {
"type": "string"
},
"dueDateFromMilestone": {
"type": "boolean"
},
"taskListId": {
"type": "integer"
},
"progress": {
"type": "integer"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"customFieldId": {
"type": "integer"
},
"value": {
"type": "string"
}
}
}
},
"crmDealIds": {
"type": "integer"
},
"followingChanges": {
"type": "boolean"
},
"followingComments": {
"type": "boolean"
},
"changeFollowerIds": {
"type": "string"
},
"commentFollowerIds": {
"type": "string"
},
"teamsFollowingChanges": {
"type": "boolean"
},
"teamsFollowingComments": {
"type": "boolean"
},
"companiesFollowingChanges": {
"type": "boolean"
},
"companiesFollowingComments": {
"type": "boolean"
},
"order": {
"type": "integer"
},
"canComplete": {
"type": "boolean"
},
"canEdit": {
"type": "boolean"
},
"canLogTime": {
"type": "boolean"
},
"canAddSubtasks": {
"type": "boolean"
},
"placeholder": {
"type": "boolean"
},
"DLM": {
"type": "integer"
}
}
},
"customFields": {
"type": "object",
"properties": {
"customFieldId": {
"type": "object",
"description": "This contains the string value of the custom field id",
"example": "100",
"properties": {
"id": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"entity": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"options": {
"type": "object",
"properties": {
"choices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"color": {
"type": "string"
}
}
}
}
}
},
"visibilities": {
"type": "array",
"items": {
"type": "object"
}
},
"isPrivate": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"createdByUserId": {
"type": "integer"
},
"updatedAt": {
"type": "string"
},
"updatedByUserId": {
"type": "integer"
},
"deleted": {
"type": "boolean"
},
"deletedAt": {
"type": "string"
},
"deletedByUserId": {
"type": "integer"
}
}
}
}
}
}
},
"examples": {
"application/json": {
"STATUS": "ullamco Duis ipsum laboris",
"task": {
"id": 57855836,
"name": "sunt",
"priority": "irure laborum",
"status": "sunt eu est",
"parentTaskId": 73016367,
"description": "laborum dolore proident et",
"canViewEstTime": false,
"updatedBy": {
"id": 46880254,
"firstName": "fugiat",
"lastName": "et",
"avatarUrl": "consequat esse sunt"
},
"createdBy": {
"id": -49964975,
"firstName": "in sed",
"lastName": "non ut pariatur velit deserunt",
"avatarUrl": "labore enim sit aliquip"
},
"dateCreated": "adipisicing",
"dateChanged": "nulla sit incididunt consequat in",
"dateLastModified": "incididunt tempor ex",
"hasFollowers": true,
"hasLoggedTime": true,
"hasReminders": false,
"hasRemindersForUser": true,
"hasRelativeReminders": false,
"hasTemplateReminders": true,
"hasTickets": true,
"isPrivate": true,
"installationId": -35711158,
"privacyIsInherited": false,
"lockdownId": 37575367,
"numMinutesLogged": -83963370,
"numActiveSubTasks": -67779445,
"numAttachments": 27400155,
"numComments": -29863860,
"numCommentsRead": -75723007,
"numCompletedSubTasks": 68251795,
"numDependencies": 98938105,
"numEstMins": -67033768,
"numPredecessors": -48690938,
"position": 34367995,
"projectId": -90147850,
"startDate": null,
"dueDate": null,
"dueDateFromMilestone": false,
"taskListId": -16678585,
"progress": -18200000,
"customFields": [
{
"id": -47912731,
"customFieldId": 83612626,
"value": "labore proident enim occaecat"
},
{
"id": -66207798,
"customFieldId": -54978752,
"value": "eiusmod"
}
],
"crmDealIds": null,
"followingChanges": false,
"followingComments": false,
"changeFollowerIds": "laborum dolore do",
"commentFollowerIds": "sit",
"teamsFollowingChanges": null,
"teamsFollowingComments": null,
"companiesFollowingChanges": null,
"companiesFollowingComments": null,
"order": -16073836,
"canComplete": false,
"canEdit": true,
"canLogTime": true,
"canAddSubtasks": true,
"placeholder": false,
"DLM": -60822779
},
"customFields": {
"200": {
"id": -25568685,
"projectId": -73579952,
"entity": "in eu",
"name": "minim dolore cillum anim",
"description": "reprehenderit pariatur in",
"type": "ipsum ut do aute",
"options": {
"choices": [
{
"value": "dolore dolor nostrud eu cupidatat",
"color": "non amet Excepteur ea"
},
{
"value": "",
"color": "nisi consectetur anim ad"
},
{
"value": "veniam sed deserunt ut occaecat",
"color": "am"
},
{
"value": "dolor ea proident culpa",
"color": "et esse"
},
{
"value": "officia cillum",
"color": "id est incididunt in"
}
]
},
"visibilities": [
{},
{},
{}
],
"isPrivate": false,
"required": true,
"createdAt": "magna id sit consequat exercitation",
"createdByUserId": 85610264,
"updatedAt": "in laborum sunt amet",
"updatedByUserId": -75899353,
"deleted": false,
"deletedAt": null,
"deletedByUserId": null
}
}
}
}
}
},
"summary": "Get Custom Fields on a task",
"tags": [
"Custom Fields"
],
"description": "Getting a specific task with it's custom fields requires you to pass in **?includeCustomFields=true**. \n\nThe task will be returned along with the custom fields associated with it.\n\nIf a task doesn't have any custom fields set, tasks.customFields is omitted from the response, not null.\n\n**Please note:** The V1 /task/{taskId}.json endpoint does not support includeCustomFields=true, you must use this V2 API.\n",
"parameters": [
{
"in": "query",
"name": "includeCustomFields",
"type": "boolean",
"default": false,
"required": true
}
]
},
"parameters": [
{
"name": "taskId",
"in": "path",
"type": "string",
"required": true
}
]
},
"/projects/api/v2/projects/{projectId}.json": {
"get": {
"responses": {
"200": {
"description": "",
"schema": {
"type": "object",
"properties": {
"customFields": {
"type": "object",
"properties": {
"customFieldId": {
"type": "object",
"description": "This contains the string value of the custom field id",
"example": "100",
"properties": {
"id": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"entity": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"options": {
"type": "object"
},
"visibilities": {
"type": "array",
"items": {
"type": "object"
}
},
"isPrivate": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"createdByUserId": {
"type": "integer"
},
"updatedAt": {
"type": "string"
},
"updatedByUserId": {
"type": "integer"
},
"deleted": {
"type": "boolean"
},
"deletedAt": {
"type": "string"
},
"deletedByUserId": {
"type": "integer"
}
}
}
}
},
"project": {
"type": "object",
"properties": {
"activePages": {
"type": "object",
"properties": {
"billing": {
"type": "boolean"
},
"comments": {
"type": "boolean"
},
"files": {
"type": "boolean"
},
"links": {
"type": "boolean"
},
"messages": {
"type": "boolean"
},
"milestones": {
"type": "boolean"
},
"notebooks": {
"type": "boolean"
},
"riskRegister": {
"type": "boolean"
},
"tasks": {
"type": "boolean"
},
"time": {
"type": "boolean"
}
}
},
"activeUserIsProjectAdmin": {
"type": "boolean"
},
"announcement": {
"type": "string"
},
"announcementHTML": {
"type": "string"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"isOwner": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
},
"createdOn": {
"type": "string"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"customFieldId": {
"type": "integer"
},
"value": {
"type": "string"
}
}
}
},
"defaultPrivacy": {
"type": "string"
},
"defaults": {
"type": "object",
"properties": {
"privacy": {
"type": "string"
}
}
},
"description": {
"type": "string"
},
"directFileUploadsEnabled": {
"type": "boolean"
},
"filesAutoNewVersion": {
"type": "boolean"
},
"harvestTimersEnabled": {
"type": "boolean"
},
"id": {
"type": "integer"
},
"integrations": {
"type": "object",
"properties": {
"onedrivebusiness": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"folder": {
"type": "string"
},
"folderName": {
"type": "string"
}
}
},
"sharepoint": {
"type": "object",
"properties": {
"account": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"folder": {
"type": "string"
},
"folderName": {
"type": "string"
}
}
},
"xero": {
"type": "object",
"properties": {
"baseCurrency": {
"type": "string"
},
"connected": {
"type": "boolean"
},
"countryCode": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"organisation": {
"type": "string"
}
}
}
}
},
"isOnBoardingProject": {
"type": "boolean"
},
"isPrivate": {
"type": "boolean"
},
"isProjectAdmin": {
"type": "boolean"
},
"isSampleProject": {
"type": "boolean"
},
"lastChangeOn": {
"type": "string"
},
"logo": {
"type": "string"
},
"member": {
"type": "boolean"
},
"name": {
"type": "string"
},
"notifyEveryone": {
"type": "boolean"
},
"overviewStartPage": {
"type": "string"
},
"privacyEnabled": {
"type": "boolean"
},
"projectOwnerId": {
"type": "integer"
},
"replyByEmailEnabled": {
"type": "boolean"
},
"showAnnouncement": {
"type": "boolean"
},
"skipWeekends": {
"type": "boolean"
},
"starred": {
"type": "boolean"
},
"startPage": {
"type": "string"
},
"status": {
"type": "string"
},
"subStatus": {
"type": "string"
},
"tasksStartPage": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
},
"examples": {
"application/json": {
"customFields": {
"226": {
"id": -59792326,
"projectId": null,
"entity": "dolore qui",
"name": "fugiat consequat in sit officia",
"description": "Duis cillum sit",
"type": "ea commodo laborum",
"options": null,
"visibilities": [
{},
{}
],
"isPrivate": true,
"required": true,
"createdAt": "ullamco in mollit",
"createdByUserId": -30467935,
"updatedAt": "irure est",
"updatedByUserId": 63471416,
"deleted": true,
"deletedAt": null,
"deletedByUserId": null
}
},
"project": {
"activePages": {
"billing": true,
"comments": true,
"files": true,
"links": true,
"messages": true,
"milestones": false,
"notebooks": true,
"riskRegister": false,
"tasks": false,
"time": false
},
"activeUserIsProjectAdmin": false,
"announcement": "ad",
"announcementHTML": "Excepteur eiusmod sint ut velit",
"company": {
"id": 46419206,
"isOwner": false,
"name": "in do tempor"
},
"createdOn": "ut aute",
"customFields": [
{
"id": -65391905,
"customFieldId": -48927513,
"value": "qui enim esse"
},
{
"id": 7374544,
"customFieldId": -92086434,
"value": "culpa l"
},
{
"id": -15533096,
"customFieldId": -4545178,
"value": "et anim reprehenderit aliquip"
},
{
"id": -47355756,
"customFieldId": -58598231,
"value": "c"
}
],
"defaultPrivacy": "ut",
"defaults": {
"privacy": "exercitation"
},
"description": "tempor eiusmod in Lorem",
"directFileUploadsEnabled": false,
"filesAutoNewVersion": true,
"harvestTimersEnabled": false,
"id": 6274261,
"integrations": {
"onedrivebusiness": {
"account": "pariatur reprehenderit dolore aliquip",
"enabled": false,
"folder": "magna sunt",
"folderName": "culpa Ut l"
},
"sharepoint": {
"account": "amet incididunt",
"enabled": true,
"folder": "Duis ut aute sed sint",
"folderName": "ut in qui elit"
},
"xero": {
"baseCurrency": "proident aliquip",
"connected": false,
"countryCode": "sed do ea Excepteur laboris",
"enabled": false,
"organisation": "consequat veniam amet dolore pariatur"
}
},
"isOnBoardingProject": false,
"isPrivate": false,
"isProjectAdmin": true,
"isSampleProject": false,
"lastChangeOn": "cupidatat",
"logo": "Excepteur in",
"member": false,
"name": "exercitation proident sin",
"notifyEveryone": false,
"overviewStartPage": "mollit sint consequat proident cupidatat",
"privacyEnabled": true,
"projectOwnerId": 78541342,
"replyByEmailEnabled": false,
"showAnnouncement": true,
"skipWeekends": false,
"starred": true,
"startPage": "dolor ipsum ad officia Duis",
"status": "amet eu consectetur exercitation cupidatat",
"subStatus": "consectetur commodo",
"tasksStartPage": "commodo cillum in nulla",
"type": "laborum sint"
}
}
}
}
},
"summary": "Get Custom Fields on a project",
"tags": [
"Custom Fields"
],
"description": "Getting a specific project with it's custom fields requires you to pass in **?includeCustomFields=true**. \n\nThe project will be returned along with the custom fields associated with it.\n\nIf a project doesn't have any custom fields set, projects.customFields is omitted from the response, not null.\n\n**Please note:** The V1 /projects/{projectId}.json endpoint does not support includeCustomFields=true, you must use this V2 API.\n",
"parameters": [
{
"in": "query",
"name": "includeCustomFields",
"type": "boolean",
"default": false,
"required": true
}
]
},
"parameters": [
{
"name": "projectId",
"in": "path",
"type": "string",
"required": true
}
]
}
}
}