Query parameters

• expand array[string]

  One or more references to expand. Any of client, planItems, departments

  Values are client, planItems, or departments.

• project array[string]

  One or more project IDs to filter the results by. This is the _id value of the project.

• projectStatus array[string]

  One or more project statuses to filter the results by.

• program array[string]

  One or more project programs to filter the results by.

• updatedAt string

  A date query to filter the results by the last updatedAt field. Format is [operation] [date], e.g. updatedAt=gt 2025-02-24T00:00:00.000Z. Acceptable operations are lt = lower than, lte = lower than or equal, gt = greater than, gte = greater than or equal. The date is in ISOString.

• startDate string

  A start date query to filter the results by. Format is [operation] [date], e.g. startDate=gt 2025-02-24T00:00:00.000Z. Acceptable operations are lt = lower than, lte = lower than or equal, gt = greater than, gte = greater than or equal. The date is in ISOString.

• endDate string

  An end date query to filter the results by. Format is [operation] [date], e.g. endDate=gt 2025-02-24T00:00:00.000Z. Acceptable operations are lt = lower than, lte = lower than or equal, gt = greater than, gte = greater than or equal. The date is in ISOString.

• select array[string]

  One or more properties to be included in the response, instead of the full payload. E.g. select=endDate,projectStatus

Responses

• 200 application/json

  Successful response

  Hide response attribute Show response attribute object

  • value array[object]
    Hide value attributes Show value 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.