---
title: "GET /user#maxResults"
method: GET
path: "/user#maxResults"
---

# GET /user#maxResults

`GET /user#maxResults`

Lists all available user accounts in FinSpace.

## Query parameters

- `nextToken` string
- `maxResults` integer, required

## Response `200`

Success

- ListUsersResponse
  - `users` User[] — A list of all the user accounts.
    - `userId` string — The unique identifier for the user.
    - `status` 'CREATING' | 'ENABLED' | 'DISABLED' — <p>The current status of the user account. </p> <ul> <li> <p> <code>CREATING</code> – The user account creation is in progress.</p> </li> <li> <p> <code>ENABLED</code> – The user account is created and is currently active.</p> </li> <li> <p> <code>DISABLED</code> – The user account is currently inactive.</p> </li> </ul>
    - `firstName` string, password — The first name of the user.
    - `lastName` string, password — The last name of the user.
    - `emailAddress` string, password — The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
    - `type` 'SUPER_USER' | 'APP_USER' — <p> Indicates the type of user.</p> <ul> <li> <p> <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p> </li> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p> </li> </ul>
    - `apiAccess` 'ENABLED' | 'DISABLED' — <p>Indicates whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>
    - `apiAccessPrincipalArn` string — The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
    - `createTime` integer — The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
    - `lastEnabledTime` integer — Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
    - `lastDisabledTime` integer — Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
    - `lastModifiedTime` integer — Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
    - `lastLoginTime` integer — Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
  - `nextToken` string — A token that indicates where a results page should begin.

## Other responses

- `480` — InternalServerException
- `481` — ValidationException
- `482` — ThrottlingException
- `483` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/finspace-data.md) · [All operations](https://skmtc.net/aws/apis/finspace-data/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/finspace-data/versions/d7561d153837/schema)