---
title: "GET /mr-api/person"
method: GET
path: "/mr-api/person"
tags: ["PersonService"]
---

# GET /mr-api/person

`GET /mr-api/person`

Gets a list of matching people.

## Query parameters

- `countGroups` boolean
- `order` 'ASC' | 'DESC'
- `filter` string
- `startAt` integer
- `pageSize` integer
- `includeLastLoggedIn` boolean
- `includeDeactivated` boolean
- `personTypes` PersonType[]
- `sortBy` 'name' | 'activationStatus'

## Response `200`

Gets all persons, alphabetically sorted

- SearchPersonResult
  - `max` integer, required
  - `people` Person[] — This is for backwards compatibility
    - `id` PersonId
      - `id` string, uuid, required
    - `name` string
    - `email` string, email
    - `personType` 'person' | 'serviceAccount' | 'sdkServiceAccount'
    - `other` string
    - `source` string
    - `version` integer
    - `passwordRequiresReset` boolean
    - `groups` Group[]
      - `createdBy` Person — recursive
      - `updatedBy` Person — recursive
      - `whenCreated` string, date-time
      - `whenUpdated` string, date-time
      - `id` string, uuid
      - `admin` boolean — is this an admin group?
      - `portfolioId` string, uuid
      - `organizationId` string, uuid — this will be the organisation this group belongs to at the top level, or if a portfolio group, the organisation of the portfolio
      - `version` integer
      - `name` string, required
      - `members` Person[]
      - `applicationRoles` ApplicationGroupRole[]
        - `applicationId` string, uuid, required
        - `groupId` string, uuid, required
        - `roles` ApplicationRoleType[], required
      - `environmentRoles` EnvironmentGroupRole[]
        - `environmentId` string, uuid, required
        - `groupId` string, uuid, required
        - `roles` RoleType[], required
      - `whenArchived` string, date-time
    - `whenArchived` string, date-time
    - `whenLastAuthenticated` string, date-time — This is the timestamp in UTC when they last logged into the system
    - `whenLastSeen` string, date-time — This is the timestamp in UTC when they last made a request to the system on their most recent login. If it is null it means they have no current token or have never logged in.
    - `additional` PersonInfo[]
      - `key` string, required — e.g. serviceAccountId
      - `value` string, required
  - `summarisedPeople` SearchPerson[] — If we return the new result type, we are returning a summarised person for less data
    - `id` string, uuid, required
    - `name` string, required
    - `email` string, email, required
    - `version` integer, required
    - `personType` 'person' | 'serviceAccount' | 'sdkServiceAccount', required
    - `whenLastAuthenticated` string, date-time — This is the timestamp in UTC when they last logged into the system
    - `whenLastSeen` string, date-time — This is the timestamp in UTC when they last made a request to the system on their most recent login. If it is null it means they have no current token or have never logged in.
    - `whenDeactivated` string, date-time — When a person's account was deactivated (if it was) and when
    - `groupCount` integer, required
  - `outstandingRegistrations` OutstandingRegistration[]
    - `id` string, uuid, required
    - `token` string, required
    - `expired` boolean, required

## Other responses

- `400` — Bad Request
- `401` — no permission
- `403` — only admins can call this API

---

[API](https://skmtc.net/featurehub-io/apis/managementresourceapi.md) · [All operations](https://skmtc.net/featurehub-io/apis/managementresourceapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/featurehub-io/managementresourceapi/versions/faed5fd616c3/schema)