---
updatedAt: 2026-06-08T03:35:06.000Z
agentTools:
  projectIndex: https://developer.moloco.cloud/llms.txt
---

# Read the user

Read the user under API caller's workplace.
If include_role specified, response will include roles bound to API caller's workplace and ad account (if exists).
The user who has any role except AD_ACCOUNT_VIEWER can call this API.
A user who has an AD_ACCOUNT_VIEWER role can only read itself.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Moloco Ads Campaign Management API",
    "description": "Moloco Ads Campaign Management API provides functionalities for Moloco Ads Campaigns.",
    "version": "1.10",
    "contact": {
      "name": "Moloco Inc.",
      "url": "https://www.moloco.com"
    }
  },
  "paths": {
    "/cm/v1/auth/users/{user_id}": {
      "get": {
        "summary": "Read the user",
        "description": "Read the user under API caller's workplace.\nIf include_role specified, response will include roles bound to API caller's workplace and ad account (if exists).\nThe user who has any role except AD_ACCOUNT_VIEWER can call this API.\nA user who has an AD_ACCOUNT_VIEWER role can only read itself.",
        "operationId": "DspApi_ReadUser",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/messagesReadUserResponse"
                }
              }
            }
          },
          "default": {
            "description": "Error. Detailed cause can be found in the `details` field.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/messagesReadUserError"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "user_id",
            "description": "The user ID.",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "include_role",
            "description": "Flag whether response includes user's role.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "tags": [
          "User"
        ]
      }
    }
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "servers": [
    {
      "url": "https://api.moloco.cloud"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "commonLocale": {
        "type": "string",
        "enum": [
          "UNKNOWN_LOCALE",
          "EN_US",
          "KO_KR",
          "JA_JP"
        ],
        "default": "UNKNOWN_LOCALE",
        "description": "Locale enumerates the supported user locale values.\n\n - EN_US: English (United States)\n - KO_KR: Korean (South Korea)\n - JA_JP: Japanese (Japan)"
      },
      "dspRole": {
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/dspRoleType",
            "description": "The role types users can have."
          },
          "workplace_id": {
            "type": "string",
            "description": "The workplace bound to the role."
          },
          "ad_account_id": {
            "type": "string",
            "description": "The ad account id bound to role."
          },
          "exchange_id": {
            "type": "string",
            "description": "The exchange id bound to role."
          }
        },
        "description": "Role that user can have.\nRole is bound to resource."
      },
      "dspRoleType": {
        "type": "string",
        "enum": [
          "WORKPLACE_OWNER",
          "AD_ACCOUNT_OWNER",
          "AD_ACCOUNT_MEMBER",
          "AD_ACCOUNT_VIEWER"
        ],
        "default": "UNKNOWN_TYPE",
        "description": " - WORKPLACE_OWNER: Workplace owner represents a user who can do anything in a given workplace.\n - AD_ACCOUNT_OWNER: Ad account owner represents a user who can do anything in a given ad account.\n - AD_ACCOUNT_MEMBER: Ad account member can view all users of the Ad Account.\nCan invite new users as Ad Account Member or Ad Account Viewer\nCan edit your own information (ex: name)\nCan create and edit ad campaigns\n - AD_ACCOUNT_VIEWER: Ad account Viewer role offers a limited set of permissions that allows users\nonly to read the basic information of the resources."
      },
      "dspUser": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "Email of User. Immutable."
          },
          "id": {
            "type": "string",
            "description": "ID of User. Immutable."
          },
          "name": {
            "type": "string",
            "description": "First name of the User."
          },
          "last_name": {
            "type": "string",
            "description": "Last name of the User."
          },
          "company_name": {
            "type": "string",
            "description": "Company name of the User."
          },
          "terms_agreed": {
            "type": "boolean",
            "description": "Whether the user agreed to terms and privacy policy."
          },
          "marketing_agreed": {
            "type": "boolean",
            "description": "Whether the user agreed to receive marketing purpose informations."
          },
          "locale": {
            "$ref": "#/components/schemas/commonLocale",
            "description": "The locale preference of the user."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time when a user was created.",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "The time when a user was updated.",
            "readOnly": true
          }
        },
        "description": "User represents a single user."
      },
      "messagesReadUserError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          },
          "details": {
            "type": "array",
            "items": {
              "type": "object",
              "$ref": "#/components/schemas/messagesReadUserErrorAPIErrorInfo"
            }
          }
        }
      },
      "messagesReadUserErrorAPIErrorInfo": {
        "type": "object",
        "properties": {
          "reason": {
            "$ref": "#/components/schemas/messagesReadUserErrorAPIErrorInfoErrorReason"
          },
          "error_log_id": {
            "type": "string"
          },
          "context": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "messagesReadUserErrorAPIErrorInfoErrorReason": {
        "type": "string",
        "enum": [
          "ERROR_REASON_UNKNOWN",
          "USER_DOES_NOT_HAVE_REQUIRED_ROLE",
          "USER_AUTH_TOKEN_REQUIRED"
        ],
        "default": "ERROR_REASON_UNKNOWN",
        "description": " - USER_DOES_NOT_HAVE_REQUIRED_ROLE: The user doesn't have role to invite other user.\n - USER_AUTH_TOKEN_REQUIRED: Token should be auth token."
      },
      "messagesReadUserResponse": {
        "type": "object",
        "properties": {
          "user_with_info": {
            "$ref": "#/components/schemas/messagesUserWithInfo",
            "description": "Invited user information."
          }
        }
      },
      "messagesUserWithInfo": {
        "type": "object",
        "properties": {
          "user": {
            "$ref": "#/components/schemas/dspUser",
            "description": "The user."
          },
          "signed_up": {
            "type": "boolean",
            "description": "Signed up status of user."
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "object",
              "$ref": "#/components/schemas/dspRole"
            },
            "description": "List of roles the user has."
          }
        }
      }
    }
  }
}
```