---
title: "List API caller's registered workplaces"
method: GET
path: "/cm/v1/auth/workplaces"
tags: ["User"]
---

# List API caller's registered workplaces

`GET /cm/v1/auth/workplaces`

List workplaces to which the user has registered.

## Query parameters

- `show_history` boolean

## Response `200`

A successful response.

- MessagesListWorkplacesResponse
  - `workplaces` DspWorkplace[] — The list of workplace.
    - `id` string — The workplace ID.
    - `title` string — The workplace title.
    - `logo_url` string — The URL of the workplace logo image file.
    - `configuration` object — The workplace's configuration.
  - `workplace_history` DspWorkplaceHistory
    - `workplace_creation_requests` DspWorkplaceCreationRequest[]
      - `id` string — Unique identifier for request.
      - `company_info` DspCompanyInfo — CompanyInfo holds the company information.
        - `name` string, required — Name of the Company.
        - `client_type` 'UNKNOWN_CLIENT_TYPE' | 'ADVERTISER' | 'AGENCY', required — Enumerates available client types. - ADVERTISER: The actual advertiser, who owns the advertising apps or web sites. - AGENCY: An agency, who usually operates ad campaigns on behalf of the advertiser.
        - `category` 'BUSINESS_CATEGORY_UNKNOWN' | 'BUSINESS_CATEGORY_GAME' | 'BUSINESS_CATEGORY_COMMERCE' | 'BUSINESS_CATEGORY_ENTERTAINMENT' | 'BUSINESS_CATEGORY_FINTECH' | 'BUSINESS_CATEGORY_FNB' | 'BUSINESS_CATEGORY_ONDEMAND' | 'BUSINESS_CATEGORY_SOCIAL_NETWORK' | 'BUSINESS_CATEGORY_OTHERS', required — Category of the business.
        - `finance_email` string, required — Email account in charge of the finance.
        - `address` string, required — Address of the company.
        - `sub_address` string — Sub address of the company.
        - `city` string, required — City of the company.
        - `state` string — State of the company.
        - `country` string, required — Country of the company.
        - `zipcode` string, required — Zipcode of the company.
      - `status` 'WORKPLACE_CREATION_REQUEST_UNKNOWN' | 'WORKPLACE_CREATION_REQUEST_PENDING' | 'WORKPLACE_CREATION_REQUEST_APPROVED' | 'WORKPLACE_CREATION_REQUEST_REJECTED' | 'WORKPLACE_CREATION_REQUEST_FAILED'
      - `reject_reason` string — Rejected reason in case request is rejected.
      - `requested_at` string, date-time — Requested time.
      - `workplace_id` string — Created workplace's ID after finalized. Only visible when request is approved.
      - `workplace_title` string — Title of the workplace.
      - `ad_account_info` DspWorkplaceCreationRequestAdAccountInfo
        - `timezone` string — [IANA timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) name. e.g. America/Los_Angeles.
        - `currency` 'UNKNOWN_CURRENCY' | 'USD' | 'KRW' | 'JPY' | 'EUR' | 'GBP' — Enumeration of currencies supported by Moloco Ads. This value is not part of the specification. - USD: US Dollar. - KRW: Korean Won. - JPY: Japanese Yen. - EUR: EU Euro. - GBP: British Pound.

## 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)