---
title: "List workplace users"
method: GET
path: "/cm/v1/auth/users"
tags: ["User"]
---

# List workplace users

`GET /cm/v1/auth/users`

List users under a certain workplace.
With `include_role` query parameter, response can include roles.
Only API callers who have a WORKPLACE_OWNER role can call this API.

## Query parameters

- `include_role` boolean
- `filter_roles` string[]
- `match_roles` string[]

## Response `200`

A successful response.

- MessagesListWorkplaceUsersResponse
  - `user_with_infos` MessagesUserWithInfo[] — List of users with additional info.
    - `user` DspUser — User represents a single user.
      - `email` string — Email of User. Immutable.
      - `id` string — ID of User. Immutable.
      - `name` string — First name of the User.
      - `last_name` string — Last name of the User.
      - `company_name` string — Company name of the User.
      - `terms_agreed` boolean — Whether the user agreed to terms and privacy policy.
      - `marketing_agreed` boolean — Whether the user agreed to receive marketing purpose informations.
      - `locale` 'UNKNOWN_LOCALE' | 'EN_US' | 'KO_KR' | 'JA_JP' — Locale enumerates the supported user locale values. - EN_US: English (United States) - KO_KR: Korean (South Korea) - JA_JP: Japanese (Japan)
      - `created_at` string, date-time — The time when a user was created.
      - `updated_at` string, date-time — The time when a user was updated.
    - `signed_up` boolean — Signed up status of user.
    - `roles` DspRole[] — List of roles the user has.
      - `type` 'WORKPLACE_OWNER' | 'AD_ACCOUNT_OWNER' | 'AD_ACCOUNT_MEMBER' | 'AD_ACCOUNT_VIEWER' — - WORKPLACE_OWNER: Workplace owner represents a user who can do anything in a given workplace. - AD_ACCOUNT_OWNER: Ad account owner represents a user who can do anything in a given ad account. - AD_ACCOUNT_MEMBER: Ad account member can view all users of the Ad Account. Can invite new users as Ad Account Member or Ad Account Viewer Can edit your own information (ex: name) Can create and edit ad campaigns - AD_ACCOUNT_VIEWER: Ad account Viewer role offers a limited set of permissions that allows users only to read the basic information of the resources.
      - `workplace_id` string — The workplace bound to the role.
      - `ad_account_id` string — The ad account id bound to role.
      - `exchange_id` string — The exchange id bound to role.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/moloco/apis/moloco-ads-campaign-management-api.md) · [All operations](https://skmtc.net/moloco/apis/moloco-ads-campaign-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moloco/moloco-ads-campaign-management-api/revisions/5c85d0910ac0/schema)