Query parameters

• person array[string]

  One or more person IDs to filter people by. This is the people[].person._id value.

• email array[string]

  One or more emails to filter people by. This is the people[].email value.

• permission array[string]

  One or more permissions to filter people by. This is the people[].permission value.

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

• role array[string]

  One or more role IDs to filter people by. This is the org.roles[]._id value.

• office array[string]

  One or more office IDs to filter people by. This is the org.offices[]._id value.

• department array[string]

  One or more department IDs to filter people by. This is the org.departments[]._id value.

• startDate string

  A date query to filter the results by the person starting date, people[].startDate. Format is startDate=<operator> <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, eq = equal. The date is in ISOString.

• endDate string

  A date query to filter the results by the person ending date, people[].endDate. Format is endDate=<operator> <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, eq = equal. The date is in ISOString.

• archived boolean | number

  If true, only archived documents will be returned. Defaults to false. If you need both archived and non-archived, use withArchived instead.

  Values are false, true, 0, or 1.

• withArchived boolean | number

  If true, both archived and non-archived documents will be returned. Defaults to false.

  Values are false, true, 0, or 1.

• updatedAt string

  A date query to filter the results by the last updatedAt value. Format is updatedAt=<operator> <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, eq = 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. You can also exclude fields by prefixing with a minus sign, e.g. select=-endDate,-projectStatus, but you cannot mix both.

• sortBy string

  Optionally, the field to sort the results by. By default, results are sorted by created date. Only updatedAt is supported at this moment (Note: updatedAt equals to createdAt for documents that have never been updated).

  Value is updatedAt.

• sortDirection string

  Optionally, the direction to sort the documents by. For ascending (oldest first) use either 1 or asc. By default sorting is descending (latest first), -1 or desc.

  Values are 1, asc, -1, or desc.

• limit integer

  Optionally, change the default document response limit of 40.

  Minimum value is 1, maximum value is 100. Default value is 40.

• count boolean | number

  Includes a count property which holds the total number of results matching the query. The value does not change between pages and represents the accurate number of results to be expected.

  Note: The use of this parameter will have a performance impact on the request of the first page.

  Values are false, true, 0, or 1.

• search string

  Search documents that contain specific words or phrases (keywords). Searches against specific document fields, such as title and description. The fields and weight of those fields depend on which collection is being searched. Note: When using search, results are scored based, which means that even non-matching documents can be returned.

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

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

    • person object
      Hide person attributes Show person attributes object

      • _id string(ObjectId)

        The unique document ID.

      • firstName string

        The person's first name.

      • lastName string

        The person's last name.

      • avatar string

        The person's profile picture.

      • city string

        The person's residing city.

      • country string

        The person's residing country.

      • state string

        The person's residing state.

      • timezone string

        The person's timezone in the IANA time zone database format, e.g. America/Toronto.

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

  • nextLink string

    The full URL to be used in order to fetch the next page of results. If not defined, it means there are no more pages.

    Note: The documents are not being counted to know when all documents have been exhausted, we simply check if the length of the paginated list is less than the paginated limit. This means that if by coincidence the last paginated document list has the same length as the paginated limit, nextLink will be defined and will result in an empty list of documents.