Path parameters

• projectId string Required

  The project's unique document ID.

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • _id string(ObjectId)

    The unique document ID.

  • createdBy string(ObjectId)

    The creator's unique document ID.

  • createdAt string(date-time)

    The date the document was created in ISOString format. See .toISOString().

  • updatedAt string(date-time)

    The date the document was last updated in ISOString format. See .toISOString().

  • org string(ObjectId)

    The organization's unique document ID.

  • startDate string(date-time)

    The start date in ISOString format. See .toISOString().

  • endDate string(date-time)

    The end date in ISOString format. See .toISOString().

  • client string(ObjectId)

    expandable The client's (or vendor, account, etc.) unique document ID referencing the organization's client, i.e. org.clients[]._id.

  • customId string

    A custom identifier for internal reference by your system (not used by missionX).

  • title string

    The title of your project.

  • description string

    A description of your project.

  • projectCode string

    A custom identifier for your project.

  • projectStatus string

    The status of the project.

    Values are open, completed, or cancelled. Default value is open.

  • departments array[string(ObjectId)]

    References the organization's departments, i.e. org.departments[]._id.

  • offices array[string(ObjectId)]

    References the organization's offices, i.e. org.offices[]._id.

  • revenueType string

    The project's billing scope.

    Values are milestones or timeAndMaterials.

  • budget number(float)

    The total project budget.

    Minimum value is 0.

  • timeTrackingEnabled boolean

    If true, time tracking features will be enabled for this project.

    Default value is false.

  • currency string(currency)

    The project's default currency in ISO 4217 format. E.g. EUR, CAD, USD, etc. If not provided, inherits from the organization.

  • inviteDomains array[string]

    Restricts invites to the project only to these email domains, e.g. ['missionx.ai']. If not provided, defaults to a single value of ['ANY'] where any email domain can be invited to the project.

  • projectType string

    Determines the type of project. Cannot be changed later.

    Values are smart-simple, modern-kanban, mx-gantt, or structured-agile.

  • usageStorage number

    The project's total file storage usage in bytes.

    Default value is 0.

  • planItems array[string(ObjectId)]

    The project's list of plan items.

  • customProperties array[object]

    Display custom properties on the project's information page that are not supported by missionX out of the box.

    Hide customProperties attributes Show customProperties attributes object

    • name string

      The custom property name.

    • value

      The custom property value. It can be of any type.

    • canView string

      The minimum role that is allowed to view this property. E.g. If set to manager, both a manager and an admin can view it, but not a member.

      Values are member, manager, or admin.

    • description string

      Optional additional information about this property.

• 400 application/json

  Bad Request

  Hide response attributes Show response attributes object

  • message string

    An error message.

  • code string

    An error code to handle specific error responses.

  • data object

    Optionally, additional data to help handle the error.

    Additional properties are allowed.

• 500 application/json

  Internal Server Error

  Hide response attributes Show response attributes object

  • message string

    An error message.

  • code string

    An error code to handle specific error responses.

  • data object

    Optionally, additional data to help handle the error.

    Additional properties are allowed.