ServiceChannel Providers API
The Providers API from ServiceChannel — 15 operation(s) for providers.
The Providers API from ServiceChannel — 15 operation(s) for providers.
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-providers-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 Providers API
isOdataApi: false
relativePath: ''
discoveryPath: docs/bearer.v1
_isAuthorizedAccess: true
servers:
- url: https://sb2fixxbook.servicechannel.com:443/api
security:
- oauth2: []
tags:
- name: Providers
paths:
/providers/ProviderData:
put:
tags:
- Providers
operationId: Providers_ProviderData
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Object'
text/json:
schema:
$ref: '#/components/schemas/Object'
deprecated: false
x-access: Subscribers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProviderDataModel'
text/json:
schema:
$ref: '#/components/schemas/UpdateProviderDataModel'
required: true
/providers/subscribers:
get:
tags:
- Providers
summary: Retrieve the list of subscribers
description: Returns the names and IDs of subscribers whose private network the provider is in.
operationId: Providers_Subscribers
parameters:
- name: providerId
in: query
description: Unique numeric identifier of the provider.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: The list of subscribers is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriberApiModel'
text/json:
schema:
$ref: '#/components/schemas/SubscriberApiModel'
'400':
description: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
'401':
description: The requested resource requires authentication.
'500':
description: Something went wrong, and the server was unable to complete your request.
deprecated: false
x-access: Providers
/api/providers/info/{id}:
get:
tags:
- Providers
operationId: GETv3_api_providers_info_{id}
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
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: Subscribers
/providers/RemoveProviderSubscriberLink:
post:
tags:
- Providers
summary: Delete provider of subscriber
description: Delete provider of subscriber.
operationId: POSTv3_providers_RemoveProviderSubscriberLink
responses:
'200':
description: Request succeeded and the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.CreateBlankProviderResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.CreateBlankProviderResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\n <br/>Error codes:\n <br/> 100 - Invalid provider id passed;\n <br/> 400 - Invalid subscriber id passed;\n <br/> 503 - Empty Request;\n <br/> 500 - Provider subscriber link has not been deleted;\n <br/> 1217 - Proccess provider subscriber link error text;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized 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'
deprecated: false
x-access: Any
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.RemoveProviderSubscriberLinkRequest'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.RemoveProviderSubscriberLinkRequest'
required: true
/providers:
post:
tags:
- Providers
summary: Create blank provider
description: Create blank provider.
operationId: POSTv3_providers
responses:
'200':
description: Request succeeded and the requested information is in the response.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.CreateBlankProviderResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.CreateBlankProviderResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\n <br/>Error codes:\n <br/> 103 - Provider already exists;\n <br/> 802 - Invalid user name;\n <br/> 806 - User already exists;\n <br/> 1150 - User does not exist;"
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized 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'
deprecated: false
x-access: Any
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.CreateBlankProviderRequest'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.CreateBlankProviderRequest'
required: true
/providers/current/problemtypes:
get:
tags:
- Providers
operationId: GETv3_providers_current_problemtypes?subscriberId={subscriberId}&dashboardId={dashboardId}&locationId={locationId}&areaId={areaId}&trade={trade}&problemType={problemType}
parameters:
- name: subscriberId
in: query
required: true
schema:
type: integer
format: int32
- name: dashboardId
in: query
required: true
schema:
type: integer
format: int32
- name: locationId
in: query
required: true
schema:
type: integer
format: int32
- name: areaId
in: query
required: true
schema:
type: integer
format: int32
- name: trade
in: query
required: true
schema:
type: string
- name: problemType
in: query
required: true
schema:
type: string
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
/providers/getbytrade:
get:
tags:
- Providers
summary: Providers For Subscriber User by Trade
description: List of Providers.
operationId: GETv3_providers_getbytrade?trade={trade}
parameters:
- name: trade
in: query
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.ProviderInfo'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.ProviderInfo'
deprecated: false
x-access: Subscribers
/providers/getbytradeid:
get:
tags:
- Providers
summary: Providers For Subscriber User by Trade
description: List of Providers.
operationId: GETv3_providers_getbytradeid?tradeId={tradeId}
parameters:
- name: tradeId
in: query
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.WebApi.Models.Response.Providers.GetProvidersByTradeIdResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.WebApi.Models.Response.Providers.GetProvidersByTradeIdResponse'
deprecated: false
x-access: Subscribers
/providers/{providerId}/feedback:
post:
tags:
- Providers
operationId: POSTv3_providers_{providerId}_feedback
parameters:
- name: providerId
in: path
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'
deprecated: false
x-access: Any
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.ProviderFeedbackRequest'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.ProviderFeedbackRequest'
required: true
/providers/updateDispatchSetting:
post:
tags:
- Providers
summary: Set isDoNotDispatch value for providers
operationId: POSTv3_providers_updateDispatchSetting
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.WebApi.Models.UpdateDispatchSettingModel'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.WebApi.Models.UpdateDispatchSettingModel'
required: true
/api/providers/IsSdiMobileEnabled:
get:
tags:
- Providers
summary: Allows one to get information whether the SDIMobileInt flag is enabled.
description: "True - if the FF is enabled for a provider and subscriber or for a provider and location.\n Otherwise it returns false."
operationId: GETv3_api_providers_IsSdiMobileEnabled?subscriberId={subscriberId}&locationId={locationId}
parameters:
- name: subscriberId
in: query
description: Subscriber id
required: false
schema:
type: integer
format: int32
- name: locationId
in: query
description: Location id
required: false
schema:
type: integer
format: int32
responses:
'200':
description: The request succeeded and the information is retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/System.Object'
text/json:
schema:
$ref: '#/components/schemas/System.Object'
deprecated: false
x-access: Providers
/providers/GetProvidersRankingStatus:
post:
tags:
- Providers
summary: Returns provider ranks for specified Fixxbook primary trade and locations
operationId: POSTv3_providers_GetProvidersRankingStatus
responses:
'200':
description: The request succeeded and the information is retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.GetProvidersRankingStatusRequest'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.GetProvidersRankingStatusRequest'
'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'
deprecated: false
x-access: Subscribers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.GetProvidersRankingStatusRequest'
text/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.GetProvidersRankingStatusRequest'
required: true
/odata/locations({locationId})/providers/Service.GetRecent(days={days}):
get:
tags:
- Providers
summary: "Get recent providers for the given location.\n \"Recent\" means a provider has completed WOs for a certain time."
operationId: Providers_GetRecent
parameters:
- name: days
in: path
required: true
schema:
type: integer
format: int32
default: 30
- name: locationId
in: path
required: true
schema:
type: integer
format: int32
- 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: The request succeeded and providers are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.ReviewedProvider'
'400':
description: The request parameters are not valid.
'401':
description: An unauthorized request.
'403':
description: Providers cannot use this method.
'404':
description: The location wasn't found.
'500':
description: Something went wrong.
deprecated: false
x-access: Any
/odata/detailedProviders/Service.Get(providerId={providerId}):
get:
tags:
- Providers
summary: Get provider by provider id.
operationId: Providers_GetProvider
parameters:
- name: providerId
in: path
required: true
schema:
type: integer
format: int32
- 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: The request succeeded and the provider is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.DetailedProvider'
'401':
description: Unauthorized request.
'403':
description: Providers cannot use this method.
'404':
description: The provider wasn't found.
'500':
description: Something went wrong.
deprecated: false
x-access: Any
/odata/locations({locationId})/providers/Service.GetLast(days={days}):
get:
tags:
- Providers
summary: Retrieve providers feedback rating data.
operationId: Providers_GetLast
parameters:
- name: days
in: path
required: true
schema:
type: integer
format: int32
default: 30
- name: locationId
in: path
required: true
schema:
type: integer
format: int32
- 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: The request succeeded and providers are returned.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Providers.ExtendedReviewedProvider'
'400':
description: The request parameters are not valid.
'401':
description: An unauthorized request.
'403':
description: Providers cannot use this method.
'404':
description: The location wasn't found.
'500':
description: Something went wrong.
deprecated: false
x-access: Any
components:
schemas:
ServiceChannel.Services.Messaging.Providers.DetailedProvider:
description: Provider with detailed information according to the current subscriber.
type: object
properties:
Contracts:
description: Contracts provider working at for the current subscriber.
type: array
items:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Contracts.Contract'
ReviewsInfo:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Feedback.ReviewsInfo'
description: Provider reviews information.
MyProviderReview:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Feedback.UserReview'
description: My review for the current provider.
ContactEmail:
description: Provider Contact email.
type: string
Phone:
type: string
FullName:
description: Full Name
type: string
Address1:
description: Address1
type: string
Address2:
description: Adress2
type: string
City:
description: City
type: string
State:
description: State
type: string
Zip:
description: Zip
type: string
Country:
description: Country
type: string
MainContact:
description: Main Contact
type: string
DateCreated:
format: date-time
description: Date Created
type: string
LastUserDate:
description: Last User Date
type: string
SuperUser:
description: SuperUser
type: string
WebSite:
description: WebSite
type: string
Email:
description: Email
type: string
TaxId:
description: Tax Id
type: string
Trade:
description: Trade
type: string
ProcessingEmail:
description: Processing Email
type: string
FaxNumber:
description: Fax Number
type: string
SuiteFloor:
description: Suite Floor
type: string
MailInfo:
description: Mail Info
type: string
ImageFile:
description: Image File
type: string
ReturnMail:
description: Return Mail
type: string
MailFrequency:
format: int32
description: Mail Frequency
type: integer
FormId:
format: int32
description: Form Id
type: integer
Pager:
description: Pager
type: string
NightRequest:
format: int32
description: NightRequest
type: integer
ShortFormatEmail:
description: Short Format Email
type: string
LastTrainingDate:
format: date-time
description: Last Training Date
type: string
LastTrainingDateStr:
description: Last Training Date as a string
type: string
IsInternal:
description: Is Internal
default: false
type: boolean
IsOnOffShoreFeatureEnabled:
description: Is OnOffShoreFeature Enabled
default: false
type: boolean
Id:
format: int32
description: Id
type: integer
Name:
description: Name
type: string
DoNotDispatch:
description: DoNotDispatch enabled?
default: false
type: boolean
System.Object:
type: object
properties: {}
ServiceChannel.Services.Messaging.Providers.ProviderInfo:
type: object
properties:
Id:
format: int32
description: Id
type: integer
Name:
description: Name
type: string
DoNotDispatch:
description: DoNotDispatch enabled?
default: false
type: boolean
SubscriberApiModel:
description: Object containing details about subscribers whose private network the provider is in.
type: object
properties:
SubscriberId:
format: int32
description: Unique numeric identifier of the subscriber
type: integer
SubscriberName:
description: Subscriber name
type: string
LinkIsActive:
description: "Defines whether a link between the provider and the subscriber is active:\n 1 — The link between the provider and subscriber is active.\n 0 — The link between the provider and subscriber is not active for one of the following reasons:\n a) The provider has accepted the client invitation, and the subscriber hasn’t accepted yet. The invitation status is *Pending*. Learn how to manage client invitations for [US-based](https://servicechannel.atlassian.net/wiki/spaces/SCUCP/pages/2372469831/Manage+Client+Invitations) and [non-US-based](https://servicechannel.atlassian.net/wiki/spaces/SCUCP/pages/2276492550/Managing+Client+Invitations) providers in ServiceChannel University.\n b) The subscriber has deactivated the provider."
type: boolean
ServiceChannel.Services.Messaging.Users.User:
description: User details object.
type: object
properties:
Id:
format: int32
description: Unique user identifier.
type: integer
SubscriberId:
format: int32
description: Unique subscriber ID.
type: integer
UserName:
description: Username of the user.<br /> • For subscriber users, the username appears as **User Id** on the "General Info" tab of the user profile page.<br /> • For provider users, the username is listed as **UserID** under "Access" on the "General" tab of the user profile page.
pattern: ^$|(^\S+).(\S).(\S)$
type: string
FullName:
description: Full name of the user.<br /> • For subscriber users, the full name appears as **User Name** on the "General Info" tab of the user profile page.<br /> • For provider users, you can see their first and last name under "Basic" on the "General" tab of the user profile page.
type: string
Email:
description: User’s email address.
type: string
PsmEmail:
description: Email address through which a user can reset their password.
type: string
Disabled:
description: Defines if a user is deactivated.
default: false
type: boolean
IsLocked:
description: Defines if a user is locked.
default: false
type: boolean
Roles:
description: Secondary roles assigned to a subscriber user that determine their permissions and level of access to various Service Automation modules.
type: array
items:
type: string
Permissions:
description: Permissions assigned to a subscriber user that determine whether they have full or read-only access to various Service Automation modules.
type: array
items:
type: string
UserType:
description: Subscriber user type defining their level of access to ServiceChannel:<br /> • `Corporate` — a user can work in Service Automation.<br /> • `Dashboard` — a user can only access the dashboard assigned to them.<br />`0` is returned for provider users.
enum:
- Corporate
- Dashboard
- ServiceChannel
type: string
Dashboard:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.DashboardInfo'
description: Dashboard a subscriber user has access to.
Access:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.AccessOptions'
description: List of locations, districts, regions, and trades a subscriber user has access to.
Limits:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.LimitOptions'
description: NTE, proposal, and invoice limits set for a subscriber user.
FeedRole:
type: string
MliUserInfo:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.MliUserInfo'
description: ''
MlpUserInfo:
$ref: '#/components/schemas/ServiceChannel.Services.Messaging.Users.MlpUserInfo'
ServiceChannel.Services.Messaging.Providers.ProviderFeedbackRequest:
type: object
properties:
StarScore:
format: int32
description: StarScore 1..5
type: integer
Comment:
description: Comment
type: string
ServiceChannel.Services.Messaging.Currencies.Currency:
type: object
properties:
Id:
format: int32
type: integer
AlphabeticalCode:
type: string
DecimalCount:
format: int32
type: integer
Entity:
type: string
CurrencyName:
type: string
NumericCode:
type: string
Rate:
format: double
type: number
ServiceChannel.Services.Messaging.Users.LimitOptions:
descri
# --- truncated at 32 KB (126 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-providers-api-openapi.yml