Query parameters

• select array[string]

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

• withArchivedPeople string

  If set to true, the list of people will also include people that have been removed from the organization.

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().

  • title string

    The title of your organization.

  • departments array[object]
    Hide departments attributes Show departments attributes object

    • _id string(ObjectId)

      The unique document ID.

    • customId string

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

    • title string

      The name of the department.

    • description string

      An optional description for the department.

  • offices array[object]
    Hide offices attributes Show offices attributes object

    • _id string(ObjectId)

      The unique document ID.

    • customId string

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

    • title string

      The name of the office.

    • description string

      An optional description for the office.

    • address string

      An optional office address.

    • country string

      An optional office country.

  • currency string(currency)

    The organization's default currency in ISO 4217 format. E.g. EUR, CAD, USD, etc.

    Default value is EUR.

  • roles array[object]

    A list of roles, that can also be used as a template when creating a project role.

    Hide roles attributes Show roles attributes object

    • _id string(ObjectId)

      The unique document ID.

    • customId string

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

    • title string

      The name of the role. E.g. Director of Engineering.

    • cost number(float)
    • costRateTime string

      Values are Hourly or Monthly. Default value is Monthly.

    • billRate number(float)
    • billRateTime string

      Value is Hourly. Default value is Hourly.

  • timesheetCodes array[object]

    The organization's list of timesheet codes.

    Hide timesheetCodes attributes Show timesheetCodes attributes object

    • _id string(ObjectId)

      The unique document ID.

    • id string

      The unique ID of the code. This is a UUID, not the code itself.

    • description string

      Optionally, describes the code.

    • isProjectLevel boolean

      If true, this is a code on the project level, e.g. MEETING for meeting hours. Otherwise it's a company level timesheet code, e.g. PTO for paid time off. Default's to false.

    • code string

      The actual code, e.g. PTO, ERR, OT, etc.

    • isArchived boolean

      If true, it means this timesheet code has been archived and no longer in use. It is kept in the list for reference purposes. Default's to false.

    • nonBillable boolean

      If true, this code tracks time spent on activities that cannot be charged to clients. Default's to false.

    • parentId string

      Optionally, another code's unique ID, i.e. timesheetCodes[].id, which will be used as the parent code. E.g. PTO could be the parent code of VAC and SICK codes.