Path parameters

• personId string Required

  The organization's person unique document ID, i.e. org.people[].person.

Query parameters

• withArchived string

  If set to true, the response will include people removed from the organization.

Responses

• 200 application/json

  Successful response

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

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

• 404

  Not Found

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