Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Project

Add a new project

post/v1/workspaces/{workspaceId}/projects

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Request body

billableboolean

Indicates whether project is billable or not.

clientIdstring

Represents client identifier across the system.

colorstring

Color format ^#(?:[0-9a-fA-F]{6}){1}$. Explanation: A valid color code should start with '#' and consist of six hexadecimal characters, representing a color in hexadecimal format. Color value is in standard RGB hexadecimal format.

isPublicboolean

Indicates whether project is public or not.

namestring required

Represents a project name.

notestring

Represents project note.

Example request

{
  "clientId": "9t641568b07987035750704",
  "color": "#000000",
  "costRate": {
    "amount": 20000,
    "since": "2020-01-01T00:00:00Z"
  },
  "estimate": {
    "estimate": "PT1H30M",
    "type": "AUTO"
  },
  "hourlyRate": {
    "amount": 20000,
    "since": "2020-01-01T00:00:00Z"
  },
  "memberships": [
    {
      "hourlyRate": {
        "amount": 20000,
        "since": "2020-01-01T00:00:00Z"
      },
      "membershipStatus": "PENDING",
      "membershipType": "PROJECT",
      "userId": "12t687e29ae1f428e7ebe202"
    }
  ],
  "name": "Software Development",
  "note": "This is a sample note for the project.",
  "tasks": [
    {
      "assigneeIds": [
        "45b687e29ae1f428e7ebe123",
        "67s687e29ae1f428e7ebe678"
      ],
      "budgetEstimate": 10000,
      "costRate": {
        "amount": 2000,
        "since": "2020-01-01T00:00:00Z"
      },
      "estimate": "PT1H30M",
      "hourlyRate": {
        "amount": 20000,
        "since": "2020-01-01T00:00:00Z"
      },
      "id": "57a687e29ae1f428e7ebe107",
      "name": "Bugfixing",
      "projectId": "5b641568b07987035750505e",
      "status": "DONE",
      "userGroupIds": [
        "67b687e29ae1f428e7ebe123",
        "12s687e29ae1f428e7ebe678"
      ]
    }
  ]
}

Response

Created

archivedboolean

Indicates whether project is archived or not.

billableboolean

Indicates whether project is billable or not.

clientIdstring

Represents client identifier across the system.

clientNamestring

Represents client name.

colorstring

Color format ^#(?:[0-9a-fA-F]{6}){1}$. Explanation: A valid color code should start with '#' and consist of six hexadecimal characters, representing a color in hexadecimal format. Color value is in standard RGB hexadecimal format.

durationstring

Represents project duration in milliseconds.

idstring

Represents project identifier across the system.

isPublicboolean
isTemplateboolean
namestring

Represents a project name.

notestring

Represents project note.

publicboolean

Indicates whether project is public or not.

templateboolean

Indicates whether project is a template or not.

workspaceIdstring

Represents workspace identifier across the system.

Example response

{
  "budgetEstimate": {
    "estimate": 600000,
    "resetOption": "WEEKLY",
    "type": "AUTO"
  },
  "clientId": "9t641568b07987035750704",
  "clientName": "Client X",
  "color": "#000000",
  "costRate": {
    "amount": 10500,
    "currency": "USD"
  },
  "duration": "60000",
  "estimate": {
    "estimate": "PT1H30M",
    "type": "AUTO"
  },
  "hourlyRate": {
    "amount": 10500,
    "currency": "USD"
  },
  "id": "5b641568b07987035750505e",
  "memberships": [
    {
      "costRate": {
        "amount": 10500,
        "currency": "USD"
      },
      "hourlyRate": {
        "amount": 10500,
        "currency": "USD"
      },
      "membershipStatus": "PENDING",
      "membershipType": "PROJECT",
      "targetId": "64c777ddd3fcab07cfbb210c",
      "userId": "5a0ab5acb07987125438b60f"
    }
  ],
  "name": "Software Development",
  "note": "This is a sample note for the project.",
  "timeEstimate": {
    "estimate": "60000",
    "resetOption": "WEEKLY",
    "type": "AUTO"
  },
  "workspaceId": "64a687e29ae1f428e7ebe303"
}