Create project

Creates a project. The current user automatically becomes a project manager.

post/projects

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/projects
Auth: one of:
- HTTP bearer
- API key in header X-Api-Key

Request body

type'private' | 'shared' required

Type of the project

namestring required

Name/title of the project

descriptionstring nullable

Detailed description of the project

Example request

{
  "type": "private",
  "name": "Development Project",
  "description": "A project for developing new features..."
}

Response

Project created successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "ownerProjectManagerId": "1357158568008091265",
    "backgroundImageId": "1357158568008091266",
    "name": "Development Project",
    "description": "A project for developing new features...",
    "backgroundType": "gradient",
    "backgroundGradient": "ocean-dive",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  },
  "included": {
    "projectManagers": [
      {
        "id": "1357158568008091264",
        "projectId": "1357158568008091265",
        "userId": "1357158568008091266",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.