Chatinbox User API
The User API from Chatinbox — 10 operation(s) for user.
The User API from Chatinbox — 10 operation(s) for user.
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/chatinbox-net:chatinbox-net-user-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: Chatinbox Net User API
version: '1.0'
x-refined-note:
- x-source differs across the merged source definitions and was not carried
description: 'Operations tagged User across 2 of this provider''s published API definitions: chatinbox-net-openapi-original.json, chatinbox-net-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.chatinbox.net
description: Host serving the Swagger UI and this spec (spec has no servers[]; paths are relative to it)
security:
- Bearer: []
tags:
- name: User
paths:
/api/users:
get:
tags:
- User
parameters:
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api users
x-summary-source: derived
operationId: getApiUsers
x-operation-id-source: derived
post:
tags:
- User
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/UserFormVM'
application/json:
schema:
$ref: '#/components/schemas/UserFormVM'
text/json:
schema:
$ref: '#/components/schemas/UserFormVM'
application/*+json:
schema:
$ref: '#/components/schemas/UserFormVM'
responses:
'200':
description: Success
summary: Create api users
x-summary-source: derived
operationId: postApiUsers
x-operation-id-source: derived
/api/usersbasic:
get:
tags:
- User
parameters:
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api usersbasic
x-summary-source: derived
operationId: getApiUsersbasic
x-operation-id-source: derived
/api/users/{id}:
get:
tags:
- User
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api users by id
x-summary-source: derived
operationId: getApiUsersById
x-operation-id-source: derived
post:
tags:
- User
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Create api users by id
x-summary-source: derived
operationId: postApiUsersById
x-operation-id-source: derived
/api/users/user-passive-control/{id}:
post:
tags:
- User
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Create api users user passive control by id
x-summary-source: derived
operationId: postApiUsersUserPassiveControlById
x-operation-id-source: derived
/api/users/set-lang/{id}:
post:
tags:
- User
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Create api users set lang by id
x-summary-source: derived
operationId: postApiUsersSetLangById
x-operation-id-source: derived
get:
tags:
- User
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api users set lang by id
x-summary-source: derived
operationId: getApiUsersSetLangById
x-operation-id-source: derived
/api/users/user-login-report:
post:
tags:
- User
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/UserLoginReportFilterVM'
application/json:
schema:
$ref: '#/components/schemas/UserLoginReportFilterVM'
text/json:
schema:
$ref: '#/components/schemas/UserLoginReportFilterVM'
application/*+json:
schema:
$ref: '#/components/schemas/UserLoginReportFilterVM'
responses:
'200':
description: Success
summary: Create api users user login report
x-summary-source: derived
operationId: postApiUsersUserLoginReport
x-operation-id-source: derived
/api/users/related-users-with-instance:
post:
tags:
- User
parameters:
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/RelatedUsersWithInstanceVM'
application/json:
schema:
$ref: '#/components/schemas/RelatedUsersWithInstanceVM'
text/json:
schema:
$ref: '#/components/schemas/RelatedUsersWithInstanceVM'
application/*+json:
schema:
$ref: '#/components/schemas/RelatedUsersWithInstanceVM'
responses:
'200':
description: Success
summary: Create api users related users with instance
x-summary-source: derived
operationId: postApiUsersRelatedUsersWithInstance
x-operation-id-source: derived
/api/users/{userId}/2fa-settings:
get:
tags:
- User
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api users by user id 2fa settings
x-summary-source: derived
operationId: getApiUsersByUserId2faSettings
x-operation-id-source: derived
put:
tags:
- User
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/TwoFactorSettingsModel'
application/json:
schema:
$ref: '#/components/schemas/TwoFactorSettingsModel'
text/json:
schema:
$ref: '#/components/schemas/TwoFactorSettingsModel'
application/*+json:
schema:
$ref: '#/components/schemas/TwoFactorSettingsModel'
responses:
'200':
description: Success
summary: Replace api users by user id 2fa settings
x-summary-source: derived
operationId: putApiUsersByUserId2faSettings
x-operation-id-source: derived
/api/users/{userId}/ip-whitelist:
get:
tags:
- User
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Get api users by user id ip whitelist
x-summary-source: derived
operationId: getApiUsersByUserIdIpWhitelist
x-operation-id-source: derived
post:
tags:
- User
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/UserIpAddressModel'
application/json:
schema:
$ref: '#/components/schemas/UserIpAddressModel'
text/json:
schema:
$ref: '#/components/schemas/UserIpAddressModel'
application/*+json:
schema:
$ref: '#/components/schemas/UserIpAddressModel'
responses:
'200':
description: Success
summary: Create api users by user id ip whitelist
x-summary-source: derived
operationId: postApiUsersByUserIdIpWhitelist
x-operation-id-source: derived
/api/users/{userId}/ip-whitelist/{id}:
put:
tags:
- User
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/UserIpAddressModel'
application/json:
schema:
$ref: '#/components/schemas/UserIpAddressModel'
text/json:
schema:
$ref: '#/components/schemas/UserIpAddressModel'
application/*+json:
schema:
$ref: '#/components/schemas/UserIpAddressModel'
responses:
'200':
description: Success
summary: Replace api users by user id ip whitelist by id
x-summary-source: derived
operationId: putApiUsersByUserIdIpWhitelistById
x-operation-id-source: derived
delete:
tags:
- User
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: header
schema:
type: string
responses:
'200':
description: Success
summary: Delete api users by user id ip whitelist by id
x-summary-source: derived
operationId: deleteApiUsersByUserIdIpWhitelistById
x-operation-id-source: derived
components:
schemas:
UserWorkGroupRelationVM:
type: object
properties:
userWorkGroupRelationID:
type: integer
format: int32
workGroupName:
type:
- string
- 'null'
workGroupID:
type: integer
format: int32
userName:
type:
- string
- 'null'
userID:
type: integer
format: int32
isDisable:
type: boolean
chatCount:
type: integer
format: int32
additionalProperties: false
RelatedUsersWithInstanceVM:
type: object
properties:
selectedUserId:
type: integer
format: int32
selectedInstanceId:
type: integer
format: int32
additionalProperties: false
TwoFactorSettingsModel:
type: object
properties:
userId:
type: integer
format: int32
isTwoFactorEnabled:
type: boolean
isUserIpRestrictionEnabled:
type: boolean
phoneNumber:
type:
- string
- 'null'
twoFactorMethod:
type: integer
format: int32
maskedPhoneNumber:
type:
- string
- 'null'
additionalProperties: false
UserIpAddressModel:
type: object
properties:
id:
type: integer
format: int32
userID:
type: integer
format: int32
ip:
type:
- string
- 'null'
description:
type:
- string
- 'null'
isActive:
type: boolean
createDate:
type: string
format: date-time
updatedDate:
type:
- string
- 'null'
format: date-time
additionalProperties: false
UserFormVM:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
surname:
type:
- string
- 'null'
username:
type:
- string
- 'null'
password:
type:
- string
- 'null'
campusID:
type: integer
format: int32
projectID:
type: integer
format: int32
groupID:
type: integer
format: int32
iconText:
type:
- string
- 'null'
email:
type:
- string
- 'null'
userMenus:
type:
- array
- 'null'
items:
type: string
isActive:
type: boolean
userRoleKey:
type:
- string
- 'null'
lang:
type:
- string
- 'null'
phoneViewPermission:
type: boolean
chatRole:
type: integer
format: int32
userRoleMenus:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UserMenuCheckboxVM'
userSkills:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SkillVM'
allSkills:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SkillVM'
allMenus:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UserMenuVM'
userMenuNames:
type:
- array
- 'null'
items:
type: string
allChatRoles:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ChatRoleSelect'
newWorkGroups:
type:
- array
- 'null'
items:
type: string
userWorkGroupRelations:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UserWorkGroupRelationVM'
newInstanceRelations:
type:
- array
- 'null'
items:
type: string
userInstanceRelations:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UserInstanceRelationVM'
companyID:
type: integer
format: int32
channelManagementPermission:
type: boolean
customerMergePermission:
type: boolean
pbxExtensionNumber:
type:
- string
- 'null'
pbxExtensionPassword:
type:
- string
- 'null'
isTwoFactorEnabled:
type: boolean
isUserIpRestrictionEnabled:
type: boolean
phoneNumber:
type:
- string
- 'null'
twoFactorMethod:
type: integer
format: int32
userIpAddresses:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UserIpAddressModel'
additionalProperties: false
SkillVM:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
description:
type:
- string
- 'null'
additionalProperties: false
ChatRoleSelect:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
additionalProperties: false
UserMenuVM:
type: object
properties:
menuKey:
type:
- string
- 'null'
urlAction:
type:
- string
- 'null'
urlController:
type:
- string
- 'null'
fontIcon:
type:
- string
- 'null'
sort:
type: integer
format: int32
id:
type: integer
format: int32
parentID:
type:
- integer
- 'null'
format: int32
isPage:
type: boolean
menuLabel:
type:
- string
- 'null'
additionalProperties: false
UserLoginReportFilterVM:
type: object
properties:
startDate:
type:
- string
- 'null'
endDate:
type:
- string
- 'null'
selectedUserId:
type:
- array
- 'null'
items:
type: integer
format: int32
gmt:
type: integer
format: int32
additionalProperties: false
UserInstanceRelationVM:
type: object
properties:
instanceID:
type: integer
format: int32
userID:
type: integer
format: int32
instanceName:
type:
- string
- 'null'
isDisable:
type: boolean
chatCount:
type: integer
format: int32
additionalProperties: false
UserMenuCheckboxVM:
type: object
properties:
userMenuID:
type: integer
format: int32
name:
type:
- string
- 'null'
isActive:
type: boolean
userRoleID:
type: integer
format: int32
userRoleName:
type:
- string
- 'null'
additionalProperties: false
securitySchemes:
Bearer:
type: apiKey
description: 'JWT Authorization header. Örnek: "Bearer {token}"'
name: Authorization
in: header
x-refined-from:
- chatinbox-net-openapi-original.json
- chatinbox-net-openapi.yml