Skip to main content
POST
Create a new project

Overview

Create a new project in your workspace. Projects help organize tasks, track progress, and manage team collaboration. Each project requires a unique name and key within the team.

Request Body

string
required
The name of the project. Must be unique within the team.Example: "Mobile App Development"
string
required
A unique project key (typically 2-5 uppercase letters). Used as a prefix for task IDs.Example: "MAD"
integer
required
The ID of the client associated with this project. If not provided, uses the internal client of the team.Example: 10
string
Detailed description of the project.Example: "Development of a cross-platform mobile application for iOS and Android"
integer
The ID of the team this project belongs to. Defaults to the current user’s team if not provided.Example: 1
array|string
User ID(s) of the project manager(s). Can be a single ID or an array of IDs.Example: [5, 7] or "5"
integer
User ID of the QA lead for this project. Defaults to the current user if not provided.Example: 8
array|string
User ID(s) of team members assigned to this project. Can be a single ID or an array of IDs.Example: [1, 2, 3, 4] or "1,2,3"
array|string
Group ID(s) associated with this project. Can be a single ID or an array of IDs.Example: [1, 2] or "1,2"
string
The start date of the project (ISO 8601 format).Example: "2025-12-01T00:00:00Z"
string
The due date for project completion (ISO 8601 format).Example: "2026-06-30T23:59:59Z"
string
default:"yes"
Whether the project is billable to the client.Allowed values: "yes", "no"Default: "yes"
integer
Visibility setting for the project. When provided, sets visiblity to 1.Example: 1

Response

integer
The unique identifier of the newly created project.
string
The name of the project.
string
The unique project key.
string
Detailed description of the project.
integer
The ID of the team this project belongs to.
object
Client information associated with this project.
array
Array of user IDs who are project managers.
integer
User ID of the QA lead.
array
Array of user IDs assigned to this project.
array
Array of group IDs associated with this project.
array
Array of user IDs watching this project.
string
The start date of the project.
string
The due date of the project.
boolean
Whether the project is billable.
string
Billable status as string (“yes” or “no”).
integer
Visibility setting for the project.
integer
Visibility flag (1 if visibility is set, 0 otherwise).
array
Array of tasks in the project (empty for new projects).
integer
Number of completed tasks (0 for new projects).
integer
User ID of the project creator.
string
The timestamp when the project was created.
string
The timestamp when the project was last updated.

Example Request

Example Request (JavaScript)

Example Response

Error Responses

Notes

  • Unique constraints: Both project name and key must be unique within the team
  • Key format: Project keys are automatically converted to uppercase and special characters are removed
  • Default team: If team_id is not provided, the current user’s team is used
  • Default client: If no client_id is provided, the internal client of the team is used (or created if it doesn’t exist)
  • Default QA lead: If not provided, defaults to the current user
  • Array or string: Fields like project_manager, users, and groups accept both array format and comma-separated string format
  • Billable default: Projects are billable by default unless explicitly set to “no”
  • Groups: When groups are provided, the project is automatically added to those groups
  • Case sensitivity: Project names are automatically capitalized

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
project
string
required

The name of the project (must be unique within team)

Example:

"Mobile App Development"

key
string
required

Unique project key (2-5 uppercase letters)

Example:

"MAD"

client_id
integer<int64>
required

The ID of the client associated with this project

Example:

10

description
string

Detailed description of the project

Example:

"Development of a cross-platform mobile application for iOS and Android"

team_id
integer<int64>

The ID of the team this project belongs to

Example:

1

project_manager

User ID(s) of project manager(s)

Example:
qa_lead
integer<int64>

User ID of the QA lead

Example:

8

users

User ID(s) of team members

Example:
groups

Group ID(s) associated with this project

Example:
start_date
string<date-time>

The start date of the project

Example:

"2025-12-01T00:00:00Z"

due_date
string<date-time>

The due date for project completion

Example:

"2026-06-30T23:59:59Z"

billable
enum<string>
default:yes

Whether the project is billable

Available options:
yes,
no
Example:

"yes"

visible
integer

Visibility setting for the project

Example:

1

Response

Project created successfully

id
integer<int64>
Example:

123

project
string
Example:

"Mobile App Development"

key
string
Example:

"MAD"

project_description
string
Example:

"Development of a cross-platform mobile application"

team_id
integer<int64>
Example:

1

client
object
project_manager
integer[]
Example:
qa_lead
integer
Example:

8

users
string[]
Example:
groups
integer[]
Example:
watcher
integer[]
starting_date
string<date-time>
due_date
string<date-time>
isBillable
boolean
Example:

true

billable
string
Example:

"yes"

visible
integer
Example:

1

visiblity
integer
Example:

1

task
object[]
completed
integer
Example:

0

user_id
integer
Example:

1

created_at
string<date-time>
updated_at
string<date-time>