How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ServiceChannel

ServiceChannel Contracts API

The Contracts API from ServiceChannel — 5 operation(s) for contracts.

Documentation Provider Profile APIs.io OpenAPI GitHub

ServiceChannel Contracts API is one of 66 APIs that ServiceChannel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contracts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version bearer.v1.

Requests are made against a single base URL, https://sb2fixxbook.servicechannel.com:443/api.

5 operations 5 paths 20 schemas 4 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
bearer.v1
Base URL
https://api.servicechannel.com/v3
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

ServiceChannel Contracts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

  • oauth2 — OAuth2 Authorization

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 4 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Contracts 5
PUT
/contracts/retire
Retire Provider Contract. When 'Trade' and 'StoreId' are not specified then provider is 'retired' from all subscriber's stores.
PUTv3_contracts_retire body → 200
GET
/contracts
Returns provider active contracts by providerId, locationId and trade
GETv3_contracts?locationId={locationId}&locationDbId={locationDbId}&providerId={providerId}&trade={trade}&tradeId={tradeId} 5 params → 200400401403500
GET
/GetPrimaryRankedProviders/{subscriberId}
Get Primary Ranked Providers of all primary ranked providers for all Trades for a given subscriber
GETv3_GetPrimaryRankedProviders_{subscriberId} 1 param → 200400401
GET
/GetPrimaryRankedProviderTrades/{subscriberId}/{providerId}
Get trades for primary ranked provider
GETv3_GetPrimaryRankedProviderTrades_{subscriberId}_{providerId} 2 params → 200400401
GET
/GetPrimaryRankedProviderLocations/{subscriberId}/{providerId}/{tradeId}
Get locations for primary ranked provider
GETv3_GetPrimaryRankedProviderLocations_{subscriberId}_{providerId}_{tradeId} 3 params → 200400401

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ServiceChannel.Services.Messaging.Location.Location (45 properties), ServiceChannel.Services.Messaging.Providers.Provider (34 properties), ServiceChannel.Services.Messaging.Subscribers.Subscriber (19 properties), ServiceChannel.Services.Messaging.Users.User (17 properties). Each schema is shown below with its type and property counts.

ServiceChannel.Services.Messaging.Location.RetireProviderRequest
object
3 properties 1 required
System.Object
object
ServiceChannel.Services.Messaging.Users.User
object
User details object.
17 properties
ServiceChannel.Services.Messaging.Currencies.Currency
object
7 properties
ServiceChannel.Services.Messaging.Users.LimitOptions
object
Object for NTE, proposal, and invoice limits set for a subscriber user.
3 properties
ServiceChannel.Services.Messaging.Users.AccessOptions
object
Object listing locations, districts, regions, and trades a subscriber user has access to. Learn more about [granting access based on locations, districts, and…
4 properties
ServiceChannel.Services.Messaging.Users.DashboardInfo
object
Dashboard details object.
3 properties
ServiceChannel.Services.Messaging.Trade.Trade
object
Trade object.
3 properties
ServiceChannel.Api.Model.Entities.Category
object
6 properties
ServiceChannel.Services.Messaging.Contracts.Contract
object
Contract object.
7 properties
ServiceChannel.Services.Messaging.Location.Location
object
General location details object.
45 properties
ServiceChannel.Services.Messaging.ErrorResponse
object
The error response object
4 properties
ServiceChannel.Services.Messaging.Users.Limit
object
Object for limit details set for a subscriber user.
2 properties
ServiceChannel.Services.Messaging.Users.MlpUserInfo
object
3 properties
ServiceChannel.Services.Messaging.Subscribers.Subscriber
object
19 properties 1 required
ServiceChannel.Services.Messaging.Providers.Provider
object
34 properties
ServiceChannel.Services.Messaging.Users.MliUserInfo
object
3 properties
ServiceChannel.Api.Model.Entities.PrimaryCategory
object
4 properties
ServiceChannel.Services.Messaging.Contracts.GetContractsResponse
object
1 property
ServiceChannel.Services.Messaging.LocationNote.LocationNote
object
Object with the location note details.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

servicechannel-contracts-api-openapi.yml Raw ↑

Other APIs ServiceChannel publishes across the network.

ServiceChannel AfterHours API
AE Profile APIs.io
ServiceChannel AIAgents API
AE Profile APIs.io
ServiceChannel Announcements API
AE Profile APIs.io
ServiceChannel ApplicationAccess API
AE Profile APIs.io
ServiceChannel Assets API
AE Profile APIs.io
ServiceChannel AssetTaskResponse API
AE Profile APIs.io
ServiceChannel AssetTypes API
AE Profile APIs.io
ServiceChannel Attachments API
AE Profile APIs.io
ServiceChannel BatchRfp API
AE Profile APIs.io
ServiceChannel Branding API
AE Profile APIs.io
ServiceChannel Categories API
AE Profile APIs.io
ServiceChannel CheckLists API
AE Profile APIs.io
#Contracts
← Back to S APIs
API Details
ID
servicechannel:servicechannel-contracts-api
Base URL
https://api.servicechannel.com/v3
Docs
https://developer.servicechannel.com/swagger/ui/index?version=3
Provider
ServiceChannel
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=servicechannel-contracts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/servicechannel-contracts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ServiceChannel Contracts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.