Sign in

v1

latestOpenAPI 3.0.02026-07-2496664456.3 KB
User

List workplace 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.

get/cm/v1/auth/users

Query parameters

include_roleboolean

Flag whether response includes user's role.

filter_rolesstring[]

Filter the users who have this role. If multiple roles are given, users who have one of these roles are filtered.

  • 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.
match_rolesstring[]

Select the users who have this role. If multiple roles are given, only users who have all of these roles are selected.

  • 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.

Response

A successful response.