---
title: "Get Dispatch Board Jobs"
method: GET
path: "/jobs/dispatch_board"
---

# Get Dispatch Board Jobs

`GET /jobs/dispatch_board`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/jobs/dispatch_board`
- Auth: API key in header `x-api-key`

## Query parameters

- `page` integer
- `count` integer
- `sort` '"ASC"' | '"DESC"'
- `sort_by` ''
- `date_type` ''
- `populate_route` boolean
- `timezone` string
- `type` ''UNASSIGNED'' | ''ASSIGNED'' | ''UNSCHEDULED'' | ''OVERDUE'' | ''ALL''
- `filter.job_category` string[]
- `filter.status` string
- `filter.keyword` string
- `filter.customer` string[]
- `filter.priority` string
- `filter.job_tags` string[]
- `filter.created_at` string
- `filter.created_by` string[]
- `filter.custom_field` string[]
- `filter.asset` string[]
- `filter.ppm` string[]
- `filter.service_contract` string[]
- `filter.job_uid` string[]
- `filter.customer_feedback` string
- `filter.recurrence_job_uid` string[]
- `filter.is_recurrence` boolean
- `filter.job_type` string
- `filter.scheduled` string
- `filter.property` string[]
- `filter.customer_organization` string
- `filter.created_at_from` string
- `filter.created_at_to` string
- `filter.from_date` string
- `filter.to_date` string
- `filter.due_date_from` string
- `filter.due_date_to` string
- `filter.service_territory` string[]
- `filter.skillset_uid` string[]
- `filter.project` string[]

## Response `200`

200

- object
  - `data` object
    - `unassigned_jobs` object
      - `data` object[]
        - `job_uid` string
        - `customer` object
          - `customer_uid` string
          - `customer_first_name` string
          - `customer_last_name` string
          - `customer_organization` object
            - `organization_uid` string
            - `organization_name` string
            - `organization_logo` unknown
            - `organization_description` unknown
            - `organization_email` unknown
            - `organization_address` object
              - …
            - `is_active` boolean
            - `is_deleted` boolean
          - `customer_company_name` string
          - `customer_email` string
          - `customer_contact_no` object
            - `mobile` string
            - `home` string
            - `work` string
          - `is_active` boolean
          - `is_deleted` boolean
        - `organization` object
          - `organization_uid` string
          - `organization_name` string
          - `organization_logo` unknown
          - `organization_description` unknown
          - `organization_email` unknown
          - `no_of_customers` integer
          - `organization_address` object
            - `city` string
            - `state` string
            - `street` string
            - `country` string
            - `landmark` string
            - `zip_code` string
            - `geo_cordinates` number[]
          - `organization_billing_address` object
            - `city` string
            - `state` string
            - `street` string
            - `country` string
            - `landmark` string
            - `zip_code` string
            - `geo_cordinates` number[]
          - `custom_fields` unknown[]
            - unknown
          - `is_active` boolean
          - `is_deleted` boolean
          - `created_at` string
          - `updated_at` string
        - `delayed_job` boolean
        - `assigned_to_team` unknown[]
          - unknown
        - `assigned_to` unknown[]
          - unknown
        - `job_title` string
        - `job_category` object
          - `category_uid` string
          - `category_name` string
          - `category_color` string
          - `estimated_duration` object
            - `days` integer
            - `hours` integer
            - `minutes` integer
        - `job_priority` string
        - `job_tags` unknown[]
          - unknown
        - `scheduled_start_time` string
        - `scheduled_end_time` string
        - `scheduled_duration` integer
        - `customer_address` object
          - `landmark` string
          - `city` string
          - `state` string
          - `street` string
          - `country` string
          - `zip_code` string
          - `first_name` string
          - `last_name` string
          - `phone_number` string
          - `email` string
          - `geo_cordinates` number[]
          - `point_coordinates` object
            - `type` string
            - `coordinates` number[]
        - `customer_billing_address` object
          - `landmark` string
          - `city` string
          - `state` string
          - `street` string
          - `country` string
          - `zip_code` string
          - `first_name` string
          - `last_name` string
          - `phone_number` string
          - `email` string
          - `geo_cordinates` number[]
          - `point_coordinates` object
            - `type` string
            - `coordinates` number[]
        - `custom_fields` unknown[]
          - unknown
        - `is_recurrence` boolean
        - `created_by` object
          - `user_uid` string
          - `first_name` string
          - `last_name` string
          - `email` string
          - `external_login_id` unknown
          - `home_phone_number` unknown
          - `designation` string
          - `emp_code` string
          - `prefix` unknown
          - `work_phone_number` unknown
          - `mobile_phone_number` unknown
          - `profile_picture` string
          - `hourly_labor_charge` unknown
          - `is_active` boolean
          - `is_deleted` boolean
          - `created_at` string
          - `updated_at` string
          - `role` object
            - `role_id` integer
            - `role_uid` string
            - `role_name` string
            - `role_key` string
            - `created_at` string
            - `updated_at` string
        - `is_deleted` boolean
        - `job_timezone` unknown
        - `job_status` unknown[]
          - unknown
        - `skills` unknown[]
          - unknown
        - `created_at` string
        - `work_order_number` integer
        - `id` string
      - `total_records` integer
      - `current_page` integer
      - `total_pages` integer
    - `assigned_jobs` object
      - `data` unknown[]
        - unknown
      - `total_records` integer
      - `current_page` integer
      - `total_pages` integer
    - `unscheduled_jobs` object
      - `data` unknown[]
        - unknown
      - `total_records` integer
      - `current_page` integer
      - `total_pages` integer
    - `overdue_jobs` object
      - `data` unknown[]
        - unknown
      - `total_records` integer
      - `current_page` integer
      - `total_pages` integer
  - `type` string

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/jobs/dispatch_board/get.md)

---

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