Create a project

POST

/projects

POST

/projects

1 curl -X POST https:/https://api/projects \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "Marketing Campaign Q3",
6   "icon": "megaphone"
7 }'

1 {
2   "project": {
3     "_id": "64b8f9a2e4b0c123456789ab",
4     "number": 42,
5     "prefix": "MK42",
6     "numberKey": "MK42-2024",
7     "name": "Marketing Campaign Q3",
8     "description": "Project for managing all marketing activities in Q3 2024.",
9     "icon": "megaphone",
10     "templateId": "tpl-987654321",
11     "sections": [
12       {
13         "id": "sec-001",
14         "kind": "task-list",
15         "title": "Initial Planning",
16         "config": {}
17       }
18     ],
19     "access": {
20       "roles": [
21         "project-manager",
22         "marketing-team"
23       ],
24       "userIds": [
25         "user-1234",
26         "user-5678"
27       ]
28     },
29     "status": "active",
30     "closedAt": "null",
31     "createdAt": "2024-06-15T09:30:00Z",
32     "updatedAt": "2024-06-15T09:30:00Z",
33     "createdBy": "user-1234",
34     "createdByAttribution": "Marketing Department",
35     "provisionAttempt": "successful",
36     "storageBackend": {
37       "kind": "managed",
38       "credentialId": "cred-abc123",
39       "rootDirectoryId": "dir-xyz789"
40     }
41   }
42 }

Creates a standalone project, or one from a template (which additionally requires project-template:use on the template). Requires project:create.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Request

This endpoint expects an object.

namestringRequired1-120 characters

iconstringRequired1-64 characters

descriptionstringOptional<=2000 charactersDefaults to

prefixstringOptionalformat: "^[A-Za-z][A-Za-z0-9]+$"2-6 characters

templateIdstringOptional>=1 character

accessobjectOptional

sectionslist of objectsOptional

storageBackendobjectOptional

Response

The created project.

projectobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error