Skip to main content
POST
/
projects
Create a project
curl --request POST \
  --url https://api.projectcor.com/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "client_id": 123,
  "template_id": 123,
  "brief": "<string>",
  "start": "2023-12-25",
  "end": "2023-12-25",
  "pm_id": 123,
  "brand_id": 123,
  "product_id": 123,
  "estimated_time": 123,
  "billable": true,
  "status": "<string>",
  "currency_id": 123,
  "evaluation_date": "2023-12-25",
  "estimated": 123,
  "fee_id": 123,
  "contract_id": 123,
  "deliverables": "<string>",
  "work_order": "<string>",
  "income_type": "fee",
  "archived": false,
  "teams": [
    {
      "id": 123,
      "user_id": [
        123
      ]
    }
  ]
}
'
{
  "id": 123,
  "name": "<string>",
  "brief": "<string>",
  "client_id": 123,
  "health": 1,
  "status": "active",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "estimated_time": 123,
  "elapsed_time": 123,
  "profitability_now": 123,
  "estimated_profitability": 123,
  "archived": true,
  "billable": true,
  "income_type": "fee",
  "pm_id": 123,
  "created_by": 123,
  "company_id": 123,
  "template_id": 123,
  "brand_id": 123,
  "product_id": 123,
  "total_estimated": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "client": {
    "id": 123,
    "name": "<string>",
    "client_status_id": 123
  },
  "pm": {
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "role_id": 123
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Project Name

client_id
integer
required

Client ID

template_id
integer

Project Template ID

brief
string

Project description or brief

start
string<date>

Project start date (YYYY-MM-DD)

end
string<date>

Project end date (YYYY-MM-DD)

pm_id
integer

Project Manager User ID

brand_id
integer

Brand ID

product_id
integer

Product ID

estimated_time
number

Estimated hours for the project

billable
boolean

Whether the project is billable

status
string

Project status

currency_id
integer

Currency ID

evaluation_date
string<date>

Project evaluation date (YYYY-MM-DD)

estimated
number

Estimated monetary value for the project

fee_id
integer

Fee ID

contract_id
integer

Contract ID

deliverables
string

Project deliverables description

work_order
string

Work order number or code

income_type
enum<string>

Income type for the project

Available options:
fee,
one_time,
hourly_rate,
contract
archived
boolean
default:false

Whether the project is archived

teams
object[]

Response

200 - application/json

Project created successfully

id
integer

Unique project identifier

name
string

Project name

brief
string

Project brief/description

client_id
integer

Associated client ID

health
enum<integer>

Project health indicator: 1 (on track), 2 (at risk), 3 (delayed), 4 (critical)

Available options:
1,
2,
3,
4
status
enum<string>

Project status

Available options:
active,
finished,
suspended
start
string<date-time>

Project start date

end
string<date-time>

Project end date

estimated_time
number

Estimated hours for the project

elapsed_time
number

Hours already logged

profitability_now
number

Current profitability percentage

estimated_profitability
number

Estimated profitability percentage

archived
boolean

Whether the project is archived

billable
boolean

Whether the project is billable

income_type
enum<string>

Project billing type

Available options:
fee,
one_time,
hourly_rate,
contract
pm_id
integer

Project Manager user ID

created_by
integer

User ID who created the project

company_id
integer

Company ID

template_id
integer

Project template ID used

brand_id
integer

Associated brand ID

product_id
integer

Associated product ID

total_estimated
number

Total estimated budget

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

client
object

Associated client object

pm
object

Project Manager details