---
title: "Get Proposals"
method: POST
path: "/proposals/GetProposals"
tags: ["Proposals"]
---

# Get Proposals

`POST /proposals/GetProposals`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/proposals/GetProposals`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/proposals/GetProposals/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- ServiceChannelServicesMessagingProposalsSearchProposalModel
  - `UserId` string
  - `CurrentLevelProposal` boolean
  - `WorkOrderId` string
  - `WorkOrderIds` integer[]
  - `ProposalId` string
  - `PurchaseOrderId` string
  - `ProjectId` string
  - `Projects` ServiceChannelServicesMessagingProjectsProject[]
    - `Id` integer
    - `Name` string
    - `Description` string
  - `DateType` 'PastMonth' | 'PastThreeMonths' | 'PastYear' | 'Custom' | 'Yesterday' | 'Today' | 'PastWeek'
  - `ProposalFilterDateType` 'ProposalDate' | 'ScheduledDate' | 'ActionDate'
  - `ProposalDateFrom` string, date-time
  - `ProposalDateTo` string, date-time
  - `PastValue` integer
  - `PastRange` 'Select' | 'Hours' | 'Days' | 'Weeks'
  - `ProposalDateFromString` string
  - `ProposalDateToString` string
  - `DatesWereClamped` boolean
  - `DatesRangeInvalid` boolean
  - `DatesRangeInvalidReason` string
  - `SortBy` 'DateDesc' | 'DateAsc' | 'ProposalNumber' | 'Trade' | 'LocationId' | 'Provider' | 'Status'
  - `WithWorkOrder` 'NA' | 'Yes' | 'No'
  - `WithAttachments` 'NA' | 'Yes' | 'No'
  - `WithRelated` 'NA' | 'Yes' | 'No'
  - `Report` 'Viewable' | 'Printable' | 'Excel'
  - `Priorities` string[]
  - `ProposalStatuses` string[]
  - `CategoriesIdName` ServiceChannelApiModelKeyValueSystemStringSystemString[]
    - `Key` string
    - `Value` string
  - `TradesIdName` ServiceChannelApiModelKeyValueSystemStringSystemString[]
    - `Key` string
    - `Value` string
  - `PrioritiesIdName` ServiceChannelApiModelKeyValueSystemStringSystemString[]
    - `Key` string
    - `Value` string
  - `Locations` string[]
  - `LocationShortNames` string[]
  - `LocationShortAddresses` string[]
  - `LocationCities` string[]
  - `StateIds` integer[]
  - `CountryIds` integer[]
  - `Regions` string[]
  - `Districts` string[]
  - `States` string[]
  - `Countries` string[]
  - `Attributes` ServiceChannelServicesMessagingProposalsIdNameValue[]
    - `Id` string
    - `Name` string
    - `Value` string
  - `LocationNoteHeaders` string[]
  - `LineItemReport` boolean
  - `Provider` string
  - `ChangedProposals` integer[]
  - `ProposalIids` string
  - `ProposalNumber` string
  - `ProposalWO` string
  - `ProviderId` integer
  - `LocationId` integer
  - `SaveReport` string
  - `ALP` integer
  - `Labels` ServiceChannelApiModelKeyValueSystemStringSystemString[]
    - `Key` string
    - `Value` string
  - `IncludeMlpCategory` boolean
  - `SubscribersIdName` ServiceChannelApiModelKeyValueSystemInt32SystemString[]
    - `Key` integer
    - `Value` string
  - `IsAssignedToMe` boolean
  - `HasAssignee` boolean
  - `IncludeOverrideProposals` boolean
  - `AmountFrom` number, double
  - `AmountTo` number, double
  - `StatusesActiveTab` string
  - `ProposalsIds` integer[]
  - `SortField` 'LocDate' | 'ProposalNumber' | 'Trade' | 'StoreId' | 'ProviderName' | 'Status' | 'SubscriberName' | 'CustomSort'
  - `SortOrder` 'ASC' | 'DESC'
  - `SortCustom` ServiceChannelServicesMessagingProposalsSortCustom[]
    - `SortField` 'LocDate' | 'ProposalNumber' | 'Trade' | 'StoreId' | 'ProviderName' | 'Status' | 'SubscriberName' | 'CustomSort'
    - `SortOrder` 'ASC' | 'DESC'
  - `Currency` ServiceChannelApiModelCurrencyCurrency
    - `Id` integer
    - `Entity` string
    - `CurrencyName` string
    - `NumericCode` string
    - `AlphabeticCode` string
    - `Rate` number, double
    - `DecimalCount` integer
  - `Offset` integer
  - `Count` integer
  - `Language` string
  - `AllUsers` boolean
  - `IsLanding` boolean
  - `IsEmergency` boolean
  - `DefaultEmergencyCutOffMinutes` integer
  - `IsPendingStatusFilter` boolean
  - `GlCodes` string[]
  - `AdditionalApprovalCodes` ServiceChannelApiModelProposalsAdditionalApprovalCodeFilter[]
    - `Header` string
    - `Values` string[]
  - `ExtendedWoStatuses` string[]
  - `PrimaryWoStatuses` string[]

## Response `200`

Indicates that the request succeeded and that the requested information is in the response.

## Other responses

- `400`: Bad Request - the request could not be understood or was missing required parameters. <br/>Error codes: <br> 400 - Bad Request <br/> 503 - Request should not be null
- `401`: Indicates that the requested resource requires authentication. <br/>Error codes: <br/> 504 - API call rejected by security permissions <br/>User does not have Location or Trade access to perform this operation
- `500`: Indicates that a generic error has occurred on the server.

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)