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

ServiceChannel Proposals API

The Proposals API from ServiceChannel — 35 operation(s) for proposals.

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

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

This API exposes 35 operations across 35 paths, and defines 84 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.

35 operations 35 paths 84 schemas 18 GET2 POST15 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 Proposals 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 35

Across 35 paths, the API surfaces 35 operations — 18 GET, 2 POST, 15 PUT. Each is listed below with its method, path, parameters, and response codes.

Proposals 35
GET
/proposals/statistics
Retrieve statistics on RFPs and proposals
GETv3_proposals_statistics?daysPeriod={daysPeriod} 1 param → 200400401
GET
/proposals/{proposalId}/recipients
Retrieve users who can be added to the list of email recipients to notify of a proposal approval or rejection
GETv3_proposals_{proposalId}_recipients 1 param → 200400401
GET
/proposals/{proposalId}/validate
Validate a proposal
GETv3_proposals_{proposalId}_validate 1 param → 200400401
PUT
/proposals/{proposalId}/reject
Reject a proposal
PUTv3_proposals_{proposalId}_reject?useProposalAlertEmails={useProposalAlertEmails} 2 params body → 204400401
PUT
/proposals/ProposalsReject
Reject proposals
PUTv3_proposals_ProposalsReject body → 204400401
GET
/proposals/GetProposalsToReject
Retrieve proposals that can be reject
GETv3_proposals_GetProposalsToReject?trackingNumber={trackingNumber} 1 param → 200400401
PUT
/proposals/{proposalId}/onhold
Put a proposal on hold
PUTv3_proposals_{proposalId}_onhold 1 param body → 204400401
PUT
/proposals/{proposalId}/approve
Approve a proposal
PUTv3_proposals_{proposalId}_approve 1 param body → 204400401
PUT
/proposals/{proposalId}/open
Open a proposal
PUTv3_proposals_{proposalId}_open 1 param body → 204400401
PUT
/proposals/{proposalId}/assignWO
Attach a work order to a proposal
PUTv3_proposals_{proposalId}_assignWO?isFromProjectsModule={isFromProjectsModule} 2 params body → 204400401
PUT
/proposals/{proposalId}/escalate
Escalate a proposal
PUTv3_proposals_{proposalId}_escalate 1 param body → 204400401
PUT
/proposals/{proposalId}/assignUser
Assign a proposal to a user
PUTv3_proposals_{proposalId}_assignUser 1 param body → 204400401
GET
/proposals
Retrieve proposals
GETv3_proposals?statuses={statuses}&assignedTo={assignedTo}&skip={skip}&top={top} 4 params → 200400401
POST
/proposals/GetProposals
Get Proposals
POSTv3_proposals_GetProposals body → 200400401500
GET
/proposals/{proposalId}/users
Retrieve users who can be assigned a proposal
GETv3_proposals_{proposalId}_users 1 param → 200400401
GET
/proposals/RejectionReasons
Retrieve proposal rejection reasons
GETv3_proposals_RejectionReasons → 200400401500
GET
/proposals/ApprovalReasons
Retrieve proposal approval reasons
GETv3_proposals_ApprovalReasons?Trade={Trade}&TradeId={TradeId}&Category={Category}&CategoryId={CategoryId} 4 params → 200400401403
GET
/proposals/AssignReasons
Retrieve the reasons for assigning a proposal
GETv3_proposals_AssignReasons?Trade={Trade}&Category={Category}&TradeId={TradeId}&CategoryId={CategoryId} 4 params → 200400401403
GET
/proposals/proposalIds
Get proposal actions by ID
GETv3_proposals_proposalIds?proposalIds[0]={proposalIds[0]}&proposalIds[1]={proposalIds[1]} 1 param → 200400401
GET
/proposals/GetUsersByLevelName
Get users by level name
GETv3_proposals_GetUsersByLevelName?levelName={levelName} 1 param → 200400401
GET
/proposals/GetMlpLevelsForSubscriber
Get MLP levels for a subscriber
GETv3_proposals_GetMlpLevelsForSubscriber → 200400401
PUT
/proposals/AddUserToMlpLevel
Add a user to an MLP level
PUTv3_proposals_AddUserToMlpLevel?userName={userName}&levelName={levelName} 2 params → 200400401
PUT
/proposals/RemoveUserFromMlpLevel
Remove a user from an MLP level
PUTv3_proposals_RemoveUserFromMlpLevel?userName={userName} 1 param → 200400401
PUT
/proposals/AssignLocationToMlpUser
Add a location to a user’s MLP level
PUTv3_proposals_AssignLocationToMlpUser?userName={userName}&location={location} 2 params → 200400401
PUT
/proposals/RemoveLocationFromMlpUser
Remove a location from a user’s MLP level
PUTv3_proposals_RemoveLocationFromMlpUser?userName={userName}&location={location} 2 params → 200400401
PUT
/proposals/{rfpId}
Delete Proposal and Rfp reference with projectId by rfpId
PUTv3_proposals_{rfpId} 1 param → 200400401
GET
/proposals/GetProposalsAssociatedWithWorkOderExceptRfp
GETv3_proposals_GetProposalsAssociatedWithWorkOderExceptRfp?trackingNumber={trackingNumber} 1 param → 200400401
PUT
/proposals/AssignProjectIdToProposalAndRfp
Assign a ProjectId to a ProposalId and Rfp
PUTv3_proposals_AssignProjectIdToProposalAndRfp?proposalId={proposalId}&projectId={projectId} 2 params → 200400401
PUT
/proposals/RemoveMlpUserValidationAsync
Whether the user can be deleted from MLP level.
PUTv3_proposals_RemoveMlpUserValidationAsync?userId={userId} 1 param → 200400401
GET
/proposals/GetProposalsAssociatedWithWorkOrderAsync
Get proposals linked to the work order
GETv3_proposals_GetProposalsAssociatedWithWorkOrderAsync?trackingNumber={trackingNumber} 1 param → 200400401500
GET
/proposals/CheckProposalCreation
Check the possibility of creating a proposal
GETv3_proposals_CheckProposalCreation?SubscriberId={SubscriberId}&ProviderId={ProviderId}&LocationId={LocationId}&TradeId={TradeId}&Currency={Currency} 5 params → 200400401
POST
/proposals/CreateProposal
Create a proposal
POSTv3_proposals_CreateProposal body → 200400401403
GET
/odata/proposals
Retrieve Proposals
Proposals_GetProposals 7 params → 200400
GET
/odata/rfps({rfpId})/proposals
Retrieve Rfp Proposals
Proposals_GetProposalsForRfp 8 params → 200
GET
/odata/proposals({proposalId})/Service.Categories()
Retrieve proposal categories
Proposals_GetProposalCategories 8 params → 200400401404500

Schemas 84

The contract defines 84 schemas that model the data the API accepts and returns. The most detailed are ServiceChannel.Services.Messaging.Workorders.WorkOrder (79 properties), ServiceChannel.Services.Messaging.Proposals.SearchProposalModel (77 properties), ServiceChannel.Services.Messaging.Assets.AssetResponse (70 properties), ServiceChannel.Services.Messaging.Invoices.Invoice (69 properties). Each schema is shown below with its type and property counts.

ServiceChannel.Api.Model.Proposals.MlpRuleAction
object
20 properties
ServiceChannel.Services.Messaging.Workorders.AssigneeUser
object
2 properties
ServiceChannel.Services.Messaging.ApprovalCodes.AdditionalApprovalCode
object
10 properties
ServiceChannel.Services.Messaging.Proposals.ProposalAssociatedWithWorkOder
object
Object containing associated proposal details.
5 properties
ServiceChannel.Services.Messaging.Users.LimitOptions
object
Object for NTE, proposal, and invoice limits set for a subscriber user.
3 properties
ServiceChannel.Api.Model.Proposals.MlpRecommendation
object
25 properties
ServiceChannel.Services.Messaging.Workorders.WeatherEvent
object
2 properties
ServiceChannel.Services.Messaging.Proposals.UpdateProposalStatusRequest
object
The request object to update a proposal status.
9 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceApprovalCodeGroup
object
5 properties
ServiceChannel.Services.Messaging.Proposals.ProposalStatus
object
5 properties
ServiceChannel.Services.Messaging.Users.DashboardInfo
object
Dashboard details object.
3 properties
ServiceChannel.Services.Messaging.Proposals.ProposalQuestionOption
object
Object containing the possible answers.
7 properties
ServiceChannel.Services.Messaging.Proposals.ProposalQuestion
object
Object containing questions configured in the proposal.
9 properties
ServiceChannel.Services.Messaging.Notes.NoteInfo
object
9 properties
ServiceChannel.Api.Model.Label
object
3 properties
ServiceChannel.Api.Model.Currency.Currency
object
7 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceTravel
object
Information on the trip.
10 properties
ServiceChannel.Services.Messaging.Assets.Warranty
object
Object containing warranty parameters.
9 properties
ServiceChannel.Services.Messaging.Invoices.Invoice
object
69 properties
ServiceChannel.Services.Messaging.Proposals.ProposalRecommendation
object
7 properties
ServiceChannel.Services.Messaging.Proposals.SearchProposalModel
object
77 properties
ServiceChannel.Services.Messaging.Proposals.ProposalStatisticsResponse
object
Object of statistics on RFPs and proposals.
7 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceMaterial
object
Information on the materials used. Add a separate object for each material.
18 properties
ServiceChannel.Services.Messaging.ApprovalCodes.AdditionalApprovalCodeOption
object
2 properties
ServiceChannel.Services.Messaging.Invoices.StatusHistoryShort
object
5 properties
ServiceChannel.Services.Messaging.Projects.Project
object
3 properties
ServiceChannel.Services.Messaging.Assets.WarrantyExpiration
object
Object containing warranty expiration details.
2 properties
ServiceChannel.Services.Messaging.CountDescriptor
object
2 properties
ServiceChannel.Services.Messaging.Proposals.ProposalCategoryColumn
object
Object containing column headers defined in the proposal form.
9 properties
ServiceChannel.Services.Messaging.Users.User
object
User details object.
17 properties
ServiceChannel.Services.Messaging.Currencies.Currency
object
7 properties
ServiceChannel.Services.Messaging.Notes.NotesDescriptor
object
3 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceAmountsDetails
object
Object containing the list of the invoice charges.
6 properties
ServiceChannel.Services.Messaging.Proposals.SortCustom
object
2 properties
ServiceChannel.Api.Model.Proposals.MlpLevelSimpleModel
object
10 properties
ServiceChannel.Services.Messaging.Workorders.WorkOrder
object
Workorder object for Messages exchenge.
79 properties
ServiceChannel.Services.Messaging.Proposals.ProposalCategory
object
Object featuring proposal categories.
11 properties
ServiceChannel.Api.Model.KeyValue_System.String_System.String
object
2 properties
ServiceChannel.Services.Messaging.Proposals.ProposalInfo
object
40 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceOther
object
The invoices material
14 properties
ServiceChannel.Api.Model.Proposals.AdditionalApprovalCodeFilter
object
2 properties
ServiceChannel.Services.Messaging.Invoices.InvoicePaymentResponse
object
Object containing the invoice payment details.
5 properties
ServiceChannel.Services.Messaging.Proposals.ProposalCategoryRow
object
Object containing cost types broken down into the rows.
24 properties
ServiceChannel.Services.Messaging.ErrorResponse
object
The error response object
4 properties
ServiceChannel.Services.Messaging.Assets.WarrantyProvider
object
Object containing warranty provider details.
3 properties
ServiceChannel.Services.Messaging.Users.UserInfo
object
The user details object.
6 properties
ServiceChannel.Services.Messaging.LocationNote.LocationNote
object
Object with the location note details.
4 properties
ServiceChannel.Services.Messaging.Workorders.WorkorderStatusDescriptor
object
3 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceCategoryMessaging
object
2 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceApprovalCode
object
10 properties
ServiceChannel.Services.Messaging.Attachments.Attachment
object
Object containing information about an attachment.
9 properties
ServiceChannel.Services.Messaging.Notes.EmailRecipientResponse
object
The email notification recipient object.
4 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceLabor
object
Information on labor. Add a separate object for each worker. When two or more workers have the same SkillLevel,LaborType, and HourlyRate, use one object and sp…
16 properties
ServiceChannel.Api.Model.Proposals.ProposalProjectSimpleModel
object
2 properties
ServiceChannel.Api.Model.Workorders.WorkOrderLabel
object
2 properties
ServiceChannel.Services.Messaging.RefrigerantTracking.AssetRefrigerant
object
37 properties
ServiceChannel.Services.Messaging.Trade.Trade
object
Trade object.
3 properties
ServiceChannel.Services.Messaging.Proposals.ProposalCategoryInfo
object
3 properties
ServiceChannel.Services.Messaging.Assets.AssetAttributesMap
object
4 properties
ServiceChannel.Services.Messaging.Proposals.MlpWoRecommendationRequest
object
The request object to escalate a proposal.
26 properties 1 required
ServiceChannel.Services.Messaging.Users.MliUserInfo
object
3 properties
ServiceChannel.Api.Model.KeyValue_System.Int32_System.String
object
2 properties
ServiceChannel.Api.Model.Proposals.MlpLevelRule
object
13 properties
ServiceChannel.Services.Messaging.Proposals.UpdateProposalsStatusRequest
object
4 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceTaxesDetails
object
Object containing the list of taxes. You can add taxes as a fixed amount or as a percentage.
10 properties
System.Object
object
ServiceChannel.Services.Messaging.Invoices.Tax2Details
object
Information on the additional tax. Only invoices for Canadian locations can have Tax2Details.
2 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceApprovalCodeChild
object
11 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.Attachments.AttachmentsDescriptor
object
1 property
ServiceChannel.Services.Messaging.IdentityObject
object
1 property
ServiceChannel.Services.Messaging.Proposals.IdNameValue
object
3 properties
ServiceChannel.Services.Messaging.ApprovalCodes.EditableAdditionalApprovalCode
object
9 properties
ServiceChannel.Services.Messaging.Assets.AssetResponse
object
Object details of an asset.
70 properties
ServiceChannel.Services.Messaging.Location.Location
object
General location details object.
45 properties
ServiceChannel.Services.Messaging.Proposals.EscalateTo
object
7 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.Equipments.EquipmentAttributeDescription
object
12 properties
ServiceChannel.Services.Messaging.Rfp.Rfp
object
25 properties
ServiceChannel.Services.Messaging.Subscribers.Subscriber
object
19 properties 1 required
ServiceChannel.Services.Messaging.Providers.Provider
object
34 properties
ServiceChannel.Services.Messaging.IssueLists.IssueTicketInformation
object
8 properties
ServiceChannel.Services.Messaging.Proposals.AssignUserToProposalRequest
object
The request object to assign a proposal to a user.
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

servicechannel-proposals-api-openapi.yml Raw ↑

Other APIs ServiceChannel publishes across the network.

ServiceChannel AfterHours API
ServiceChannel AIAgents API
ServiceChannel Announcements API
ServiceChannel ApplicationAccess API
ServiceChannel Assets API
ServiceChannel AssetTaskResponse API
ServiceChannel AssetTypes API
ServiceChannel Attachments API
ServiceChannel BatchRfp API
ServiceChannel Branding API
ServiceChannel Categories API
ServiceChannel CheckLists API
Where this information came from

This is an independent, third-party profile of ServiceChannel Proposals 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.