The user-controller API from AdReady (CPXi) — 14 operation(s) for user-controller.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/adready-cpxi:adready-cpxi-user-controller-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Kickstart User Controller API
description: API documentation for Kickstart services
contact:
name: Your Team
email: support@example.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '1.0'
servers:
- url: https://platform.digitalremedy.com
description: Generated server url
tags:
- name: user-controller
paths:
/api/users/{userId}/mapAdvertisers:
put:
tags:
- user-controller
operationId: mapAdvertisers
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserAdvertiser'
required: true
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
summary: Map advertisers
x-summary-source: derived
/api/users/{userId}/mapAccounts:
put:
tags:
- user-controller
operationId: mapAccounts
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserAccount'
required: true
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiResponse'
summary: Map accounts
x-summary-source: derived
/api/users/{id}:
get:
tags:
- user-controller
operationId: get_1
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiResponseUserDTO'
summary: Get 1
x-summary-source: derived
put:
tags:
- user-controller
operationId: update_1
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/User'
required: true
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiResponseUserDTO'
summary: Update 1
x-summary-source: derived
delete:
tags:
- user-controller
operationId: delete_1
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiResponse'
summary: Delete 1
x-summary-source: derived
/api/users:
get:
tags:
- user-controller
operationId: getAll
parameters:
- name: accountId
in: query
required: false
schema:
type: integer
format: int32
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiResponseListUserDTO'
summary: Get all
x-summary-source: derived
post:
tags:
- user-controller
operationId: create_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/User'
required: true
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiResponseUserDTO'
summary: Create 1
x-summary-source: derived
/api/users/{userId}/password_reset/url:
post:
tags:
- user-controller
operationId: createPasswordResetUrl
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiResponseString'
summary: Create password reset url
x-summary-source: derived
/api/users/{userId}/invite:
post:
tags:
- user-controller
operationId: inviteUser
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
type: object
summary: Invite user
x-summary-source: derived
/api/users/{userId}/invite/url:
post:
tags:
- user-controller
operationId: inviteUserUrl
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiResponseString'
summary: Invite user url
x-summary-source: derived
/api/users/{userId}/globalRoles/{roleId}:
post:
tags:
- user-controller
operationId: updateUserRoles
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
- name: roleId
in: path
required: true
schema:
type: integer
format: int32
- name: userRole
in: query
required: true
schema:
$ref: '#/components/schemas/UserRole'
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserRole'
summary: Update user roles
x-summary-source: derived
delete:
tags:
- user-controller
operationId: deleteUserRoles
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
- name: roleId
in: path
required: true
schema:
type: integer
format: int32
- name: userRole
in: query
required: true
schema:
$ref: '#/components/schemas/UserRole'
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
summary: Delete user roles
x-summary-source: derived
/api/users/{userId}/activateSolution:
post:
tags:
- user-controller
operationId: activateSolution
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
- name: accountName
in: query
required: true
schema:
type: string
- name: advertiserName
in: query
required: true
schema:
type: string
- name: solutionName
in: query
required: true
schema:
type: string
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
type: object
summary: Activate solution
x-summary-source: derived
/api/users/{userId}/globalRoles:
get:
tags:
- user-controller
operationId: findUserGlobalRoles
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/UserRole'
summary: Find user global roles
x-summary-source: derived
/api/users/organization:
get:
tags:
- user-controller
operationId: getUserByOrgId
parameters:
- name: orgId
in: query
required: true
schema:
type: integer
format: int32
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/User'
summary: Get user by org id
x-summary-source: derived
/api/users/advertiser:
get:
tags:
- user-controller
operationId: getUsersByAdvertiserId
parameters:
- name: advertiserId
in: query
required: true
schema:
type: integer
format: int32
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiResponseListUserDTO'
summary: Get users by advertiser id
x-summary-source: derived
/api/users/{userId}/removeAdvertiser:
delete:
tags:
- user-controller
operationId: removeAdvertiser
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserAdvertiser'
required: true
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
summary: Remove advertiser
x-summary-source: derived
/api/users/{userId}/removeAccount:
delete:
tags:
- user-controller
operationId: removeAccount
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserAccount'
required: true
responses:
'400':
description: Bad Request
content:
'*/*':
schema:
type: object
'200':
description: OK
summary: Remove account
x-summary-source: derived
components:
schemas:
ApiResponseString:
type: object
properties:
status:
type: integer
format: int32
message:
type: string
result:
type: string
Permission:
type: object
properties:
entity:
type: string
enum:
- User
- Account
- Advertiser
- RateCard
- Organization
id:
type: integer
format: int32
privilege:
type: string
enum:
- All
- Read
- Create
- Delete
UserAdvertiser:
type: object
properties:
advertiserId:
type: integer
format: int32
userId:
type: integer
format: int64
Role:
type: object
properties:
canCreateRole:
type: array
items:
type: string
id:
type: integer
format: int32
name:
type: string
permissions:
type: array
items:
$ref: '#/components/schemas/Permission'
uniqueItems: true
ApiResponse:
type: object
properties:
status:
type: integer
format: int32
message:
type: string
result: {}
UserAccount:
type: object
properties:
accountId:
type: integer
format: int32
userId:
type: integer
format: int64
UserApplication:
type: object
properties:
applicationId:
type: integer
format: int32
id:
type: integer
format: int32
UserRole:
type: object
properties:
role:
$ref: '#/components/schemas/Role'
roleId:
type: integer
format: int32
userId:
type: integer
format: int64
ApiResponseUserDTO:
type: object
properties:
status:
type: integer
format: int32
message:
type: string
result:
$ref: '#/components/schemas/UserDTO'
UserDTO:
type: object
properties:
acceptedTos:
type: boolean
accountIds:
type: array
items:
type: integer
format: int32
allowedDomains:
type: string
createdAt:
type: string
format: date-time
createdBy:
type: string
deletedAt:
type: string
format: date-time
email:
type: string
emailVerificationDate:
type: string
format: date-time
emailVerified:
type: boolean
enabled:
type: boolean
flags:
type: array
items:
type: string
id:
type: integer
format: int64
lastLogin:
type: string
format: date-time
loginCount:
type: integer
format: int32
organizationId:
type: integer
format: int32
phone:
type: string
promptLibrary:
type: string
provider:
type: string
enum:
- GOOGLE
- DR_SSO
- LOCAL
- NONE
role:
$ref: '#/components/schemas/Role'
team:
type: boolean
teamUserIds:
type: array
items:
type: integer
format: int64
teams:
type: array
items:
$ref: '#/components/schemas/User'
uniqueItems: true
updatedAt:
type: string
format: date-time
updatedBy:
type: string
userApplications:
type: array
items:
$ref: '#/components/schemas/UserApplication'
uniqueItems: true
userName:
type: string
verificationMailSent:
type: boolean
selfServe:
type: boolean
inviteAccepted:
type: boolean
ApiResponseListUserDTO:
type: object
properties:
status:
type: integer
format: int32
message:
type: string
result:
type: array
items:
$ref: '#/components/schemas/UserDTO'
User:
type: object
properties:
acceptedTos:
type: boolean
accountIds:
type: array
items:
type: integer
format: int32
allowedDomains:
type: string
createdAt:
type: string
format: date-time
createdBy:
type: string
deletedAt:
type: string
format: date-time
email:
type: string
emailVerificationDate:
type: string
format: date-time
emailVerified:
type: boolean
enabled:
type: boolean
flags:
type: array
items:
type: string
id:
type: integer
format: int64
lastLogin:
type: string
format: date-time
loginCount:
type: integer
format: int32
organizationId:
type: integer
format: int32
password:
type: string
phone:
type: string
promptLibrary:
type: string
provider:
type: string
enum:
- GOOGLE
- DR_SSO
- LOCAL
- NONE
role:
$ref: '#/components/schemas/Role'
team:
type: boolean
teamUserIds:
type: array
items:
type: integer
format: int64
teams:
type: array
items:
$ref: '#/components/schemas/User'
uniqueItems: true
updatedAt:
type: string
format: date-time
updatedBy:
type: string
userApplications:
type: array
items:
$ref: '#/components/schemas/UserApplication'
uniqueItems: true
userName:
type: string
verificationMailSent:
type: boolean
x-provenance:
method: harvested
publisher: AdReady (CPXi)
source: https://platform.digitalremedy.com/v3/api-docs
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)