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.

  • clients array[object]

    A list of clients (vendors, accounts, etc.).

    Hide clients attributes Show clients 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 client.

    • emailDomains array[string]

      The last part (after the @) of any client emails you might want to give access to projects. E.g. missionx.ai

    • departments array[string]

      One or more department IDs associated with this client, i.e. org.departments[]._id

  • 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.

  • people array[object]

    The organization's list of people.

    Hide people attributes Show people attributes object

    • _id string(ObjectId)

      The unique document ID.

    • permission string

      Determines the person's permissions within the organization. The member and projectManager do not have access to the organization space, they are just employees. A manager has limited access to the organization space, like managing basic organizational settings, invoice information, leave requests, etc. An admin has full control over the organization. The observer can view everything, but not change anything.

      Values are member, projectManager, manager, admin, or observer.

    • startDate string(date-time)

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

    • endDate string(date-time)

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

    • archived boolean

      If true, the person has been removed from the organization.

    • archivedAt string

      The date the person was removed from the organization in ISO 4217 format.

    • person string

      The person's unique document ID.

    • role string

      Reference to an org role, i.e. org.roles[]._id

    • roleTitle string

      The title of the role. E.g. Director of Sales

    • email string(email)

      The person's email in the organization.

    • departments array[string(ObjectId)]

      Departments this person belongs to. References the organization's departments, i.e. org.departments[]._id.

    • office string(ObjectId)

      The person's office location. References the organization's offices, i.e. org.offices[]._id.

    • invitePendingSince number(integer)

      The timestamp the person was invited to the organization. If this field is defined, it means that the invitation is still pending.

    • canCreateProjects boolean

      If true, this person can create projects for this organization.

      Default value is false.

    • canApproveRoles boolean

      If true, this person can approve project roles.

      Default value is false.

    • canApproveLeaves boolean

      If true, this person can approve leave requests.

      Default value is false.

    • customProperties array[object]

      Display custom properties on the organization's person 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, projectManager, manager, or admin.

      • description string

        Optional additional information about this property.