---
title: "Get All Projects"
method: GET
path: "/projects"
---

# Get All Projects

`GET /projects`

## Query parameters

- `page` string
- `limit` string
- `sort` 'ASC' | 'DESC'
- `sort_by` 'project_name' | 'project_number' | 'project_priority' | 'created_at' | 'updated_at'
- `filter.is_active` string
- `filter.project_uid` string
- `filter.is_deleted` string
- `filter.keyword` string
- `filter.due_date` string
- `filter.start_date` string
- `filter.end_date` string
- `filter.customer_organization` string
- `filter.customer` string
- `filter.updated_at_from` string
- `filter.updated_at_to` string
- `filter.property` string
- `filter.asset` string
- `filter.assigned_to` string
- `filter.tags` string
- `filter.custom_field` string
- `filter.project_manager` string
- `filter.created_by` string
- `filter.project_status` string
- `filter.priority` string

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `project_uid` string
    - `project_prefix` string
    - `project_number` integer
    - `project_icon` string
    - `project_name` string
    - `project_category` object
      - `category_uid` string
      - `category_name` string
      - `display_order` integer
      - `is_deleted` boolean
      - `created_at` string
      - `updated_at` string
      - `__v` integer
      - `category_color` string
      - `category_description` string
      - `estimated_duration` object
        - `days` integer
        - `hours` integer
        - `minutes` integer
    - `project_priority` string
    - `project_description` string
    - `project_template` unknown
    - `project_current_status` object
      - `project_status_uid` string
      - `project_status_name` string
      - `project_status_type` string
      - `project_status_color` string
    - `project_completion_percentage` integer
    - `project_start_date` string
    - `project_end_date` string
    - `project_actual_start_date` string
    - `project_actual_end_date` string
    - `project_service_address` object
      - `landmark` string
      - `city` string
      - `state` string
      - `street` string
      - `country` string
      - `zip_code` string
      - `geo_cordinates` number[]
      - `first_name` string
      - `last_name` string
      - `phone_number` string
      - `email` string
    - `project_billing_address` object
      - `landmark` string
      - `city` string
      - `state` string
      - `street` string
      - `country` string
      - `zip_code` string
      - `geo_cordinates` number[]
      - `first_name` string
      - `last_name` string
      - `phone_number` string
      - `email` string
    - `project_due_date` string
    - `organization` object
      - `is_active` boolean
      - `is_deleted` boolean
      - `organization_address` object
        - `city` string
        - `state` string
        - `street` string
        - `landmark` string
        - `geo_cordinates` number[]
        - `first_name` string
        - `last_name` string
        - `phone_number` string
        - `email` string
      - `organization_name` string
      - `organization_logo` string
      - `organization_email` string
      - `organization_description` string
      - `organization_billing_address` object
        - `city` string
        - `state` string
        - `street` string
        - `landmark` string
        - `geo_cordinates` integer[]
        - `first_name` string
        - `last_name` string
        - `phone_number` string
        - `email` string
      - `organization_uid` string
      - `no_of_customers` integer
      - `custom_fields` object[]
        - `label` string
        - `value` string
        - `type` string
        - `hide_to_fe` boolean
        - `hide_field` boolean
        - `read_only` boolean
        - `_id` string
      - `created_at` string
      - `updated_at` string
    - `project_tags` string[]
    - `custom_fields` object[]
      - `label` string
      - `value` string
      - `type` string
      - `hide_to_fe` boolean
      - `hide_field` boolean
      - `read_only` boolean
      - `_id` string
    - `project_assigned_to` object[]
      - `user` object
        - `user_uid` string
        - `first_name` string
        - `last_name` string
        - `email` string
        - `external_login_id` unknown
        - `home_phone_number` string
        - `designation` string
        - `emp_code` string
        - `prefix` unknown
        - `work_phone_number` string
        - `mobile_phone_number` unknown
        - `profile_picture` string
        - `hourly_labor_charge` integer
        - `is_active` boolean
        - `is_deleted` boolean
        - `created_at` string
        - `updated_at` string
      - `team` object
        - `team_uid` string
        - `team_name` string
        - `team_color` string
        - `is_active` boolean
        - `is_deleted` boolean
    - `project_public_url` string
    - `is_deleted` boolean
    - `is_active` 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` number
      - `is_active` boolean
      - `is_deleted` boolean
      - `created_at` string
      - `updated_at` string
    - `project_status` unknown[]
      - unknown
    - `created_at` string
    - `updated_at` string
    - `project_number_string` string
    - `project_priority_index` integer
    - `__v` integer
    - `id` string
    - `project_manager` object
  - `total_records` integer
  - `current_page` integer
  - `total_pages` integer

## Other responses

- `400` — 400

---

[API](https://skmtc.net/zuper/apis/zuper-pro-api.md) · [All operations](https://skmtc.net/zuper/apis/zuper-pro-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zuper/zuper-pro-api/versions/c7b8028a05de/schema)