> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # List Team Dispatches GET https://dispatch/team-dispatches Filterable, paginated list of team dispatches across the tenant. Default scope is active (unassigned_at IS NULL); pass status=closed for closed dispatches or status=all for both. Each row embeds a team summary (name, code, member count) and work-order identity (uuid, work_order_number). Reference: https://docs.itspropel.com/propel-biz/24-dispatcher/team-dispatch/list-team-dispatches ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /dispatch/team-dispatches: get: operationId: list-team-dispatches summary: List Team Dispatches description: >- Filterable, paginated list of team dispatches across the tenant. Default scope is active (unassigned_at IS NULL); pass status=closed for closed dispatches or status=all for both. Each row embeds a team summary (name, code, member count) and work-order identity (uuid, work_order_number). tags: - subpackage_24Dispatcher.subpackage_24Dispatcher/teamDispatch parameters: - name: team_id in: query description: 'Optional: Filter to one team - string UUID - "{{team_uuid}}"' required: false schema: type: string - name: work_order_id in: query description: >- Optional: Filter to one work order - string UUID - "{{work_order_uuid}}" required: false schema: type: string - name: crew_status in: query description: 'Optional: Filter by crew status - staffed|understaffed|lead_missing' required: false schema: type: string - name: status in: query description: >- Optional: active (unassigned_at IS NULL) | closed (unassigned_at IS NOT NULL) | all - default "active" required: false schema: type: string - name: dispatched_from in: query description: 'Optional: Lower bound on dispatched_at - date format Y-m-d' required: false schema: type: string - name: dispatched_to in: query description: 'Optional: Upper bound on dispatched_at - date format Y-m-d' required: false schema: type: string - name: dispatched_by in: query description: 'Optional: Filter by dispatcher user UUID - string UUID' required: false schema: type: string - name: sort_by in: query description: >- Optional: Sort column - dispatched_at|unassigned_at|crew_status - default dispatched_at required: false schema: type: string - name: sort_direction in: query description: 'Optional: Sort direction - asc|desc - default desc' required: false schema: type: string - name: per_page in: query description: 'Optional: Results per page - integer 1-100 - default 15' required: false schema: type: integer - name: page in: query description: 'Optional: Page number - default 1' required: false schema: type: integer - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/24 Dispatcher_Team Dispatch_List Team Dispatches_Response_200 servers: - url: https:/ components: schemas: 24 Dispatcher_Team Dispatch_List Team Dispatches_Response_200: type: object properties: {} description: Empty response body title: 24 Dispatcher_Team Dispatch_List Team Dispatches_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/dispatch/team-dispatches" querystring = {"team_id":"a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f1a9d8c","work_order_id":"d9f8a7b6-c5e4-4d3f-8a1b-2c7d9e0f4a5b","crew_status":"staffed","status":"active","dispatched_from":"2024-04-01","dispatched_to":"2024-04-30","dispatched_by":"f1e2d3c4-b5a6-7890-1234-56789abcdef0","sort_by":"dispatched_at","sort_direction":"desc","per_page":"15","page":"1"} payload = { "{{tenant_key_value1}}|{{tenant_key_value2}}": "tenant123|region-west" } headers = { "{{tenant_key_name}}": "X-Tenant-Key", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://https/dispatch/team-dispatches?team_id=a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f1a9d8c&work_order_id=d9f8a7b6-c5e4-4d3f-8a1b-2c7d9e0f4a5b&crew_status=staffed&status=active&dispatched_from=2024-04-01&dispatched_to=2024-04-30&dispatched_by=f1e2d3c4-b5a6-7890-1234-56789abcdef0&sort_by=dispatched_at&sort_direction=desc&per_page=15&page=1'; const options = { method: 'GET', headers: {'{{tenant_key_name}}': 'X-Tenant-Key', 'Content-Type': 'application/json'}, body: '{"{{tenant_key_value1}}|{{tenant_key_value2}}":"tenant123|region-west"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/dispatch/team-dispatches?team_id=a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f1a9d8c&work_order_id=d9f8a7b6-c5e4-4d3f-8a1b-2c7d9e0f4a5b&crew_status=staffed&status=active&dispatched_from=2024-04-01&dispatched_to=2024-04-30&dispatched_by=f1e2d3c4-b5a6-7890-1234-56789abcdef0&sort_by=dispatched_at&sort_direction=desc&per_page=15&page=1" payload := strings.NewReader("{\n \"{{tenant_key_value1}}|{{tenant_key_value2}}\": \"tenant123|region-west\"\n}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("{{tenant_key_name}}", "X-Tenant-Key") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/dispatch/team-dispatches?team_id=a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f1a9d8c&work_order_id=d9f8a7b6-c5e4-4d3f-8a1b-2c7d9e0f4a5b&crew_status=staffed&status=active&dispatched_from=2024-04-01&dispatched_to=2024-04-30&dispatched_by=f1e2d3c4-b5a6-7890-1234-56789abcdef0&sort_by=dispatched_at&sort_direction=desc&per_page=15&page=1") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["{{tenant_key_name}}"] = 'X-Tenant-Key' request["Content-Type"] = 'application/json' request.body = "{\n \"{{tenant_key_value1}}|{{tenant_key_value2}}\": \"tenant123|region-west\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://https/dispatch/team-dispatches?team_id=a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f1a9d8c&work_order_id=d9f8a7b6-c5e4-4d3f-8a1b-2c7d9e0f4a5b&crew_status=staffed&status=active&dispatched_from=2024-04-01&dispatched_to=2024-04-30&dispatched_by=f1e2d3c4-b5a6-7890-1234-56789abcdef0&sort_by=dispatched_at&sort_direction=desc&per_page=15&page=1") .header("{{tenant_key_name}}", "X-Tenant-Key") .header("Content-Type", "application/json") .body("{\n \"{{tenant_key_value1}}|{{tenant_key_value2}}\": \"tenant123|region-west\"\n}") .asString(); ``` ```php request('GET', 'https://https/dispatch/team-dispatches?team_id=a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f1a9d8c&work_order_id=d9f8a7b6-c5e4-4d3f-8a1b-2c7d9e0f4a5b&crew_status=staffed&status=active&dispatched_from=2024-04-01&dispatched_to=2024-04-30&dispatched_by=f1e2d3c4-b5a6-7890-1234-56789abcdef0&sort_by=dispatched_at&sort_direction=desc&per_page=15&page=1', [ 'body' => '{ "{{tenant_key_value1}}|{{tenant_key_value2}}": "tenant123|region-west" }', 'headers' => [ 'Content-Type' => 'application/json', '{{tenant_key_name}}' => 'X-Tenant-Key', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/dispatch/team-dispatches?team_id=a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f1a9d8c&work_order_id=d9f8a7b6-c5e4-4d3f-8a1b-2c7d9e0f4a5b&crew_status=staffed&status=active&dispatched_from=2024-04-01&dispatched_to=2024-04-30&dispatched_by=f1e2d3c4-b5a6-7890-1234-56789abcdef0&sort_by=dispatched_at&sort_direction=desc&per_page=15&page=1"); var request = new RestRequest(Method.GET); request.AddHeader("{{tenant_key_name}}", "X-Tenant-Key"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"{{tenant_key_value1}}|{{tenant_key_value2}}\": \"tenant123|region-west\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "{{tenant_key_name}}": "X-Tenant-Key", "Content-Type": "application/json" ] let parameters = ["{{tenant_key_value1}}|{{tenant_key_value2}}": "tenant123|region-west"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://https/dispatch/team-dispatches?team_id=a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f1a9d8c&work_order_id=d9f8a7b6-c5e4-4d3f-8a1b-2c7d9e0f4a5b&crew_status=staffed&status=active&dispatched_from=2024-04-01&dispatched_to=2024-04-30&dispatched_by=f1e2d3c4-b5a6-7890-1234-56789abcdef0&sort_by=dispatched_at&sort_direction=desc&per_page=15&page=1")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```