ServiceChannel Users API
The Users API from ServiceChannel — 11 operation(s) for users.
The Users API from ServiceChannel — 11 operation(s) for users.
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/servicechannel-users-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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:
version: bearer.v1
title: Fixxbook.Bearer.Api.V1 AfterHours Users API
isOdataApi: false
relativePath: ''
discoveryPath: docs/bearer.v1
_isAuthorizedAccess: true
servers:
- url: https://sb2fixxbook.servicechannel.com:443/api
security:
- oauth2: []
tags:
- name: Users
paths:
/users:
get:
tags:
- Users
summary: Users collection
description: "Returns the list of all users of the current subscriber (the main user is also included) for successful request.\n <br />**Note**: This method is available to subscriber users with the *Super Admin* secondary role."
operationId: GETv3_users?subscriberId={subscriberId}&startIndex={startIndex}&maxCount={maxCount}&userFilterType={userFilterType}&feedRolesFilter[0]={feedRolesFilter[0]}&feedRolesFilter[1]={feedRolesFilter[1]}&includeMliInfo={includeMliInfo}&includeMlpInfo={includeMlpInfo}&includeTotalCount={includeTotalCount}
parameters:
- name: subscriberId
in: query
description: Unique numeric identifier of the subscriber. Optional
required: false
schema:
type: integer
format: int32
- name: startIndex
in: query
description: Start item index. Optional, 0 by Default
required: false
schema:
type: integer
format: int32
- name: maxCount
in: query
description: Items count to get. Optional, all items by Default.
required: false
schema:
type: integer
format: int32
- name: userFilterType
in: query
description: Return only users of a given type. Optional, corporate by default.
required: false
schema:
type: string
enum:
- Corporate
- All
- name: feedRolesFilter
in: query
description: Return users only with assigned Feed Roles. Optional, return all users by default.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: includeMliInfo
in: query
description: Include Mli user info in response. Optional, false by default
required: false
schema:
type: boolean
default: false
- name: includeMlpInfo
in: query
description: Include Mlp user info in response. Optional, false by default
required: false
schema:
type: boolean
default: false
- name: includeTotalCount
in: query
description: Include total user count in response. Optional, false by default
required: false
schema:
type: boolean
default: false
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.User'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.User'
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "Indicates that the requested resource does not exist on the server.\n <br/>Error codes:\n <br/> 502 - Users not found;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
post:
tags:
- Users
summary: Create a user
description: "Creates a new user. Returns a unique user ID for a successful request.\n <br />***Note:*** Available for subscribers with the Admin User and Super Admin secondary roles."
operationId: POSTv3_users
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
text/json:
schema:
$ref: '#/components/schemas/System.Object'
deprecated: false
x-access: Any
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.AddUserRequest'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.AddUserRequest'
description: The user object that needs to be created.
required: true
/users/{id}:
get:
tags:
- Users
summary: Retrieve a user
description: Returns the information of the specified user.
operationId: GETv3_users_{id}
parameters:
- name: id
in: path
description: Numeric Id of the User to perform action with.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.GetUserResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.GetUserResponse'
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "Indicates that the requested resource does not exist on the server.\n <br/>Error codes:\n <br/>502 - User not found;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
put:
tags:
- Users
summary: Update a user
description: "Updates the information of the specified user. Returns User Id for successful request.\n <br />**Note**: This method is available to subscriber users with the *Super Admin* secondary role and provider users with admin access."
operationId: PUTv3_users_{id}
parameters:
- name: id
in: path
description: Numeric Id of the User to perform action with.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
text/json:
schema:
$ref: '#/components/schemas/System.Object'
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'403':
description: Indicates that the server refuses to fulfill the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: Indicates that a generic error has occurred on the server.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.UpdateUserRequest'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.UpdateUserRequest'
description: The request model to perform action with.
required: true
delete:
tags:
- Users
summary: Disable a user
description: "Disables the account of the specified user.\n <br>**Note**: This method is available to subscriber users with the *Super Admin* role and provider users with admin access.</br><br>To enable the user account, use the [PUT /users/{userId}](/swagger/index.html#/Users/PUTv3_users_%7Bid%7D) or [PATCH /users/{userId}](/swagger/index.html#/Users/PATCHv3_users_%7Bid%7D) method.</br><br>Find out more about disabling and enabling users via [Service Automation](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/557645921/Disabling+Enabling+Users) and [Provider Automation](https://servicechannel.atlassian.net/wiki/spaces/SCUCP/pages/2372469124/Deactivate+Users+and+Manage+Inactive+Users) in ServiceChannel University.</br>"
operationId: DELETEv3_users_{id}
parameters:
- name: id
in: path
description: Unique numeric identifier of the user.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: User is disabled successfully.
'400':
description: The request was not accepted due to bad syntax, missing parameters, insufficient data, etc.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "The requested resource requires authentication.\n <br/>Error codes:\n 504 - API call rejected by security permissions"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: The requested resource does not exist on the server.
deprecated: false
x-access: Any
patch:
tags:
- Users
summary: Patch user's info
operationId: PATCHv3_users_{id}
parameters:
- name: id
in: path
description: User identifier
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Indicates that the update user profile request was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
text/json:
schema:
$ref: '#/components/schemas/System.Object'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: "Indicates that a generic error has occurred on the server.\n <br/>Error codes:\n <br/> 501 - Unhandled exception occurred"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
requestBody:
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/System.Object'
text/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/System.Object'
description: Patch user's profile info model (only properties to be patched)
required: true
/users/current/profile:
get:
tags:
- Users
operationId: GETv3_users_current_profile
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
text/json:
schema:
$ref: '#/components/schemas/System.Object'
deprecated: false
x-access: Any
/users/current/menu:
get:
tags:
- Users
operationId: GETv3_users_current_menu
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.MenuResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.MenuResponse'
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'403':
description: Indicates that the requested resource not allowed for current user.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "Indicates that the requested resource does not exist on the server.\n <br/>Error codes:\n <br/> 502 - Users not found;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/users/{userId}/islocked:
get:
tags:
- Users
summary: Is locked
description: "Returns true if requested user is locked.\n <br />**Note**: This method is available to subscriber users with the *Super Admin* secondary role."
operationId: GETv3_users_{userId}_islocked
parameters:
- name: userId
in: path
description: Numeric Id of the User to perform action with.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
default: false
type: boolean
text/json:
schema:
default: false
type: boolean
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: Indicates that a generic error has occurred on the server.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/users/features:
get:
tags:
- Users
summary: Returns user features object
operationId: GETv3_users_features
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ApplicationAccess.FeatureResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ApplicationAccess.FeatureResponse'
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: Indicates that a generic error has occurred on the server.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/users/current/subscriberFeatures:
get:
tags:
- Users
summary: Returns Subscriber features object
operationId: GETv3_users_current_subscriberFeatures
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ApplicationAccess.FeatureResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ApplicationAccess.FeatureResponse'
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'403':
description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\n <br/>Error codes: \n 100 — User has no rights to perform this action."
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: Indicates that a generic error has occurred on the server.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/users/current/locationNoteRestrictions:
get:
tags:
- Users
summary: Returns user location note restrictions object
operationId: GETv3_users_current_locationNoteRestrictions
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.User.UserLocationNoteRestrictionResponse'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.User.UserLocationNoteRestrictionResponse'
'400':
description: Bad Request - the request could not be understood or was missing required parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\n <br/>Error codes:\n <br/> 504 - API call rejected by security permissions;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: Indicates that a generic error has occurred on the server.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/employees/{employeeId}/users:
get:
tags:
- Users
summary: Retrieve provider users with the specified employee ID
description: "Returns a list of provider users with the specified employee ID. Provider admins can set an employee identifier on the **Employee Details** tab of the user profile.\n <br />**Note**: This method is only available to provider users with admin access."
operationId: GETv3_employees_{employeeId}_users
parameters:
- name: employeeId
in: path
description: Non-unique identifier of a provider user.
required: true
schema:
type: string
responses:
'200':
description: Provider users with the specified employee ID are in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.User'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.User'
deprecated: false
x-access: Providers
/users/regionalSettings:
get:
tags:
- Users
summary: Retrieve user localization settings
description: ''
operationId: GETv3_users_regionalSettings
responses:
'200':
description: User Localization settings are in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.User.UserLocalizationSettings'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.User.UserLocalizationSettings'
deprecated: false
x-access: Any
/odata/users:
get:
tags:
- Users
summary: Retrieve a list of users
description: '<para>**Note**: This method is available to subscriber users with the *Super Admin* secondary role and provider users with admin access.</para>'
operationId: Users_GetUsers
parameters:
- name: $expand
in: query
description: Expand a navigation property.
required: false
schema:
type: string
- name: $select
in: query
description: Select a set of properties to return.
required: false
schema:
type: string
- name: $filter
in: query
description: Filter a collection of resources addressed by a request URL.
required: false
schema:
type: string
- name: $orderby
in: query
description: Order resources by the specified property in the response.
required: false
schema:
type: string
- name: $top
in: query
description: Return the specified number of items in the response.
required: false
schema:
type: integer
- name: $skip
in: query
description: Skip the specified number of items in the response.
required: false
schema:
type: integer
- name: $count
in: query
description: Include the count of the matching resources in the response.
required: false
schema:
type: boolean
responses:
'200':
description: Indicates that the request succeeded and that the requested information is in the response.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.User'
deprecated: false
x-access: Any
components:
schemas:
ServiceChannel.Services.Messaging.User.UserLocationNoteRestrictionResponse:
type: object
properties:
Header:
type: string
Values:
type: array
items:
type: string
ServiceChannel.Services.Messaging.Users.Limit:
description: Object for limit details set for a subscriber user.
type: object
properties:
Amount:
format: double
description: Limit amount.
type: number
CurrencyId:
format: int32
description: Identifier of the currency the limit is set in.
type: integer
ServiceChannel.Services.Messaging.Users.MlpUserInfo:
type: object
properties:
Id:
format: int32
type: integer
MlpLevel:
type: string
MlpLocations:
type: array
items:
format: int32
type: integer
ServiceChannel.Services.Messaging.ErrorResponse:
description: The error response object
type: object
properties:
ErrorCodes:
description: The list of error codes. Go to /basics/general/response-codes/#internal-error-codes-and-messages to map error codes to error reasons.
type: array
items:
enum:
- NotAllowed
- EmptyProvider
- InvalidProviderId
- UnknownProvider
- ProviderAlreadyExists
- ProviderIdNotExists
- TimeoutExpiredError
- EmptyContract
- ContractUndefined
- EmptySubscriber
- InvalidSubscriberId
- UnknownSubscriber
- InactiveSubscriber
- EmptySubscriberId
- SubscriberIdNotExists
- InternalError
- DataNotFound
- BadRequest
- UnAuthori
# --- truncated at 32 KB (110 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-users-api-openapi.yml