---
title: "List all users"
method: GET
path: "/account/v2/users"
tags: ["User"]
---

# List all users

`GET /account/v2/users`

## Request

- Base URL: `https://marketplace.appdirect.com/api`
- URL: `https://marketplace.appdirect.com/api/account/v2/users`
- Auth: none declared
- TypeScript: <https://skmtc.dev/appdirect/apis/companies/docs/account/v2/users/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves all marketplace users

## Query parameters

- `name` string
- `email` string
- `externalId` string
- `username` string
- `companyMembershipRole` string
- `custom.customAttributeName` string
- `lastModified` number
- `page` integer
- `size` integer
- `sortField` 'DATE' | 'FIRST_NAME' | 'LAST_NAME'
- `sortOrder` 'ASC' | 'DESC'
- `includeCustomAttributes` boolean

## Response `200`

Success

- PagedUserAccountV2, nullable: A paged collection of UserAccountV2 objects
  - `links` Link[]: Resource links
    - `href` string
    - `rel` string
  - `page` PageMetadata
    - `number` number, required: Page number
    - `size` number, required: Size of the page to be returned
    - `totalElements` number, required: Total number of elements
    - `totalPages` number, required: Total number of pages
  - `content` UserAccountV2[]: An array of paged users
    - `links` Link[]: Resource links
      - `href` string
      - `rel` string
    - `activated` boolean: Is this user activated
    - `boostUser` BoostUser, nullable
      - `apsUid` string
    - `creationDate` number: User creation date in UNIX Epoch milliseconds
    - `customAttributes` CustomAttributeAccountV2[]: Custom attributes for this company
      - `attributeType` 'TEXT' | 'MULTISELECT'
      - `hint` string: Localized hint
      - `label` string: Localized label
      - `name` string: Name
      - `value` string: Value
      - `valueKeys` string[]: Value keys
    - `email` string: Email address
    - `externalId` string: External identifier of user
    - `firstName` string, nullable: First name
    - `lastName` string, nullable: Last name
    - `allowLogin` boolean: The user is able to log into a marketplace. By default allowLogin=true
    - `lastSuccessfulLogin` number: User last successful login date in UNIX Epoch milliseconds
    - `ldapId` string, nullable: Ldap integration
    - `idpUuid` string, nullable: The external identity provider's ID for the user
    - `locale` string: User locale in the standard ISO 639-1 language code + ISO 3166-1 country code format. For example: 'en_US', 'fr_CA', and so on.
    - `metadata` object
    - `openid` string: OpenID URL
    - `picture` string, nullable: Profile picture URL
    - `roles` string[]: User roles. All responses include ROLE_USER (end-user access). If the user has the Network Manager role, this array also includes ROLE_CORPORATE_ADMIN. For company membership roles, see [UserCompanyMembershipAccountV2](#usercompanymembershipaccountv2).
    - `userId` number: ID
    - `username` string, nullable: User name. If not provided, use the user's email address
    - `uuid` string: Unique identifier of the user assigned by the AppDirect platform

## Other responses

- `401`: Unauthorized

## Changes

- **2026-11-06** `1fc240f06971`: 1 breaking
  - removed the media type `*/*` for the response with the status `200`

[Operation history](https://skmtc.dev/appdirect/apis/companies/changes/account/v2/users/get.md)

---

[API](https://skmtc.dev/appdirect/apis/companies.md) - [All operations](https://skmtc.dev/appdirect/apis/companies/llms.txt) - [OpenAPI document](https://skmtc.dev/appdirect/apis/companies/revisions/1fc240f06971?raw)