---
title: "Performs search of work requests by specified filter expression. One page contains 50 items by default (\"PageSize\"=50). To get next 50 items use the “Page” parameter (for example Page=2 and so on)."
method: POST
path: "/workrequests/search"
tags: ["WorkRequests"]
---

# Performs search of work requests by specified filter expression. One page contains 50 items by default ("PageSize"=50). To get next 50 items use the “Page” parameter (for example Page=2 and so on).

`POST /workrequests/search`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/workrequests/search`
- 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/workrequests/search/post.ts> (a function with typed inputs; its response is checked against the schema)

*In limited availability phase.*

## Request body

- ServiceChannelServicesMessagingWorkRequestsSearchWorkRequestRequest: Object to perform search for work requests
  - `Ids` integer[]: Ids
  - `SubscriberIds` integer[]: Subscriber Ids
  - `ProviderIds` integer[]: Provider Ids
  - `LocationIds` integer[]: Location Ids
  - `CategoryIds` integer[]: Category Ids
  - `StatusIds` integer[]: Status Ids
  - `ExtendedStatusIds` integer[]: Extended Status Ids
  - `PriorityIds` integer[]: Priority Ids
  - `TradeIds` integer[]: Trade Ids
  - `ClosedReasonIds` integer[]: Closed Reason Ids
  - `EventIds` string[]: Event Ids
  - `WorkOrderIds` integer[]: Work Order Ids
  - `AssetIds` integer[]: Asset Ids
  - `CallDateFrom` string: Minimum Call Date
  - `CallDateTo` string: Maximum Call Date
  - `ScheduledDateFrom` string: Minimum Scheduled Date
  - `ScheduledDateTo` string: Maximum Scheduled Date
  - `ClosedDateFrom` string: Minimum Closed Date
  - `ClosedDateTo` string: Maximum Closed Date
  - `SortField` 'Id' | 'CallDate' | 'ScheduledDate' | 'ClosedDate': Sort Field
  - `SortDirection` 'Asc' | 'Desc': Sort direction
  - `Page` integer: Page. Zero based
  - `PageSize` integer: Page Size

## Response `200`

Work requests are in the response.

- ServiceChannelServicesMessagingWorkRequestsWorkRequest[]
  - `Id` integer: Id
  - `SubscriberId` integer: Subscriber Id
  - `SubscriberShortName` string: Subscriber Short Name
  - `ProviderId` integer: Provider Id
  - `ProviderShortName` string: Provider Short Name
  - `LocationId` integer: Location Id
  - `LocationStoreId` string: Location Store Id
  - `EventId` string: Event Id
  - `StatusId` integer: Status Id
  - `StatusName` string: Status Name
  - `ExtendedStatusId` integer: Extended Status Id
  - `ExtendedStatusName` string: Extended Status Name
  - `ClosedReasonId` integer: Closed Reason Id
  - `ClosedReasonName` string: Closed Reason Name
  - `Description` string: Description
  - `TradeId` integer: Trade Id
  - `TradeName` string: Trade Name
  - `CategoryId` integer: Category Id
  - `CategoryName` string: Category Name
  - `PriorityId` integer: Priority Id
  - `PriorityName` string: Priority Name
  - `Caller` string: Caller
  - `CallDate` string, date-time: Call Date
  - `ClosedDate` string, date-time: Closed Date
  - `ScheduledDate` string, date-time: Scheduled Date
  - `WorkOrderId` integer: Work Order Id
  - `AssetId` integer: Asset Id
  - `Nte` ServiceChannelServicesMessagingWorkRequestsWorkRequestNte: Work Request Nte
    - `Value` number, double: Value
    - `CurrencyId` integer: Currency Id
    - `CurrencyAlphabeticCode` string: Currency Alphabetic Code
  - `Issue` ServiceChannelServicesMessagingWorkRequestsWorkRequestIssue: Work Request Issue
    - `AreaId` integer: Area Id
    - `AreaName` string: Area Name
    - `ProblemType` string: Problem Type
    - `Equipment` string: Equipment
    - `ProblemCode` string: Problem Code
    - `SetupId` integer: Setup Id

## Other responses

- `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 8100 - CallDateFrom has wrong format 8101 - CallDateTo has wrong format 8102 - ScheduledDateFrom has wrong format 8103 - ScheduledDateTo has wrong format 8104 - CloseDateFrom has wrong format 8105 - CloseDateTo has wrong format
- `401`: The request is not authorized. <br/>Error codes: 504 — API call rejected by security permissions
- `500`: The server was unable to complete the request due to an internal error.

---

[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)