# List org people

**GET /orgs/people**




## Servers
- https://open.api.missionx.ai/v2: https://open.api.missionx.ai/v2 ()


## Authentication methods
- O auth2


## Parameters


### 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.
- **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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
- **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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
- **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.
- **withArchived** (boolean | number)
  If true, both archived and non-archived documents will be returned. Defaults to false.
- **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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
- **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).
- **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`.
- **limit** (integer)
  Optionally, change the default document response limit of `40`.
- **count** (boolean | number)
  Includes a `count` property in the response, which holds the total number of results matching the query. The value does not change between pages and represents the accurate, total number of results to be expected.

  Note: The use of this parameter will have a performance impact on the first paginated request.
- **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
Successful response

#### Body: application/json (object)
- **value** (array[object])

- **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.
- **count** (number)
  The total count of results for the specific request. It's included in the response only when the `count` boolean query parameter is provided and truthy, e.g. `?count=1`. The value is being calculated only during the first request and then repeated on the subsequent paginated responses.


[Powered by Bump.sh](https://bump.sh)