Project object representation

The project object representation and fields are described below.

project was introduced in API version V1

project has not been marked for deprecation

Usages

Description

Representation of a project which can be used to collect a set of tasks with workflows.

Example create representation

{
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "name" : "App launch",
  "dueTimestamp" : "2025-10-10T13:40:00"
}

Example response representation

{
  "urn" : "4c5b4343-e8aa-42a5-839e-04c0a7405a18",
  "url" : "/n/v1/project/4c5b4343-e8aa-42a5-839e-04c0a7405a18",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "name" : "App launch",
  "createdTimestamp" : "2025-09-10T13:40:00",
  "dueTimestamp" : "2025-10-10T13:40:00"
}

Fields

NameTypeDescriptionConstraints
urnString representation of a Unique Resource Name. Typically a UUID with 36 characters.The URN of the project defined in a company
urlURL represented as a stringThe URL to address project requests
ownercompanyThe owner company for the taskRequired on create. Ignored on update.
nameString literalThe name of the project (friendly name)Required on create. Maximum length: 255.
createdTimestampTimestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.The creation timestamp for the project
dueTimestampTimestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.The due date for the project