v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get All Projects

get/projects

Query parameters

pagestring
limitstring
sort'ASC' | 'DESC'
sort_by'project_name' | 'project_number' | 'project_priority' | 'created_at' | 'updated_at'
filter.is_activestring
filter.project_uidstring
filter.is_deletedstring
filter.keywordstring
filter.due_datestring
filter.start_datestring
filter.end_datestring
filter.customer_organizationstring
filter.customerstring
filter.updated_at_fromstring
filter.updated_at_tostring
filter.propertystring
filter.assetstring
filter.assigned_tostring
filter.tagsstring
filter.custom_fieldstring
filter.project_managerstring
filter.created_bystring
filter.project_statusstring
filter.prioritystring

Response

200

typestring
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "project_uid": "e3f12ca0-cb06-11ee-a449-939bad2b294a",
      "project_prefix": "Test ",
      "project_number": 3,
      "project_icon": "Testing",
      "project_name": "color code",
      "project_category": {
        "category_uid": "63932f00-c3f8-11ee-8e97-5d343b8a24b1",
        "category_name": "textttst",
        "display_order": 1,
        "created_at": "2024-02-05T07:30:08.514Z",
        "updated_at": "2024-02-05T10:28:56.524Z",
        "category_color": "#000",
        "category_description": "<p>ff<br></p>",
        "estimated_duration": {
          "days": 1,
          "hours": 1,
          "minutes": 1
        }
      },
      "project_priority": "MEDIUM",
      "project_description": "some description about project",
      "project_current_status": {
        "project_status_uid": "9c481ec0-6b19-11ed-bae3-7da4b580c234",
        "project_status_name": "Started",
        "project_status_type": "STARTED",
        "project_status_color": "rgb"
      },
      "project_completion_percentage": 90,
      "project_start_date": "2021-11-01T18:30:00.000Z",
      "project_end_date": "2021-12-01T18:30:00.000Z",
      "project_actual_start_date": "2021-11-01T18:30:00.000Z",
      "project_actual_end_date": "2021-12-01T18:30:00.000Z",
      "project_service_address": {
        "landmark": "near jain college",
        "city": "Thoraipakkam ",
        "state": "Tamil Nadu ",
        "street": "Jain College, D B Jain College main enterence, Jothi Nagar",
        "country": "India",
        "zip_code": "600097",
        "geo_cordinates": [
          12.9469543
        ],
        "first_name": "Test",
        "last_name": "User",
        "phone_number": "1234567890",
        "email": "testuser@yopmail.com"
      },
      "project_billing_address": {
        "landmark": "near jain college",
        "city": "Thoraipakkam ",
        "state": "Tamil Nadu ",
        "street": "Jain College, D B Jain College main enterence, Jothi Nagar",
        "country": "India",
        "zip_code": "600097",
        "geo_cordinates": [
          12.9469543
        ],
        "first_name": "Test",
        "last_name": "User",
        "phone_number": "1234567890",
        "email": "testuser@yopmail.com"
      },
      "project_due_date": "2021-12-01T18:30:00.000Z",
      "organization": {
        "is_active": true,
        "organization_address": {
          "city": "Chennai ",
          "state": "Tamil Nadu ",
          "street": "Amelio Early Education - Ascendas IT Park, CSIR Road, Tharamani, India",
          "geo_cordinates": [
            12.9855685
          ]
        },
        "organization_name": "Ascendas",
        "organization_logo": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/acb9ba40-8211-11eb-ab1f-1ddf213d24b4.jpg",
        "organization_email": "ascendas@abc.com",
        "organization_description": "<p><span style=\"background-color: rgb(255, 255, 0); color: #000000;\">Ascendas</span> is located in <strong>Taramani</strong>. It has <span style=\"background-color: rgb(239, 239, 239); color: #ff0000;\">3 phases. </span>asd sad gfgf fgfg dfdf dfrg dfdf dfddd ddfd dfdf dfd asdasd</p>\n<ol>\n<li>one</li>\n<li>two</li>\n<li>three</li></ol><p><a href=\"https://www.apple.com/in/apple-watch-ultra/\">link</a><br></p><ol>\n</ol>",
        "organization_billing_address": {
          "city": "Chennai",
          "state": "Tamil Nadu",
          "street": "Ascendas Phase 1",
          "landmark": "Near Taramani bus stand"
        },
        "organization_uid": "11d86a70-8212-11eb-ab1f-1ddf213d24b4",
        "no_of_customers": 43,
        "custom_fields": [
          {
            "label": "LookUp",
            "type": "LOOKUP",
            "_id": "6401c0251c380c4e487555a6"
          }
        ],
        "created_at": "2021-03-11T02:32:48.537Z",
        "updated_at": "2023-03-14T14:29:04.606Z"
      },
      "project_tags": [
        "tag 1"
      ],
      "custom_fields": [
        {
          "label": "Sage Customer ID",
          "type": "SINGLE_LINE",
          "_id": "65cc654eb213919d9bfc04f9"
        }
      ],
      "project_assigned_to": [
        {
          "user": {
            "user_uid": "6c513b60-ff7c-11e7-b3a8-29b417a4f3fa",
            "first_name": "Raghav",
            "last_name": "G",
            "email": "raghav@zuper.co",
            "home_phone_number": "7397722822",
            "designation": "CTO",
            "emp_code": "1234",
            "work_phone_number": "7397722822",
            "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/3d87e6d0-e8d8-11ed-adf9-a5fc91f5c57c.jpeg",
            "hourly_labor_charge": 500,
            "is_active": true,
            "created_at": "2024-01-16T13:59:59.000Z",
            "updated_at": "2024-01-16T13:59:59.000Z"
          },
          "team": {
            "team_uid": "18cada40-021b-11e8-8127-43a5add1a9e2",
            "team_name": "SF Team",
            "team_color": "#3498db",
            "is_active": true
          }
        }
      ],
      "project_public_url": "hello.com",
      "is_active": true,
      "created_by": {
        "user_uid": "d083c6cb-9202-41fc-8ae2-e986939c5471",
        "first_name": "Jerin",
        "last_name": "Aj",
        "email": "jerin@zuper.co",
        "designation": "Admin",
        "emp_code": "J001",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/9f1e58b0-5396-11ee-af3b-ed82d39ae946.jpg",
        "hourly_labor_charge": 54.59,
        "is_active": true,
        "created_at": "2022-02-16T10:00:42.000Z",
        "updated_at": "2023-09-15T07:08:08.000Z"
      },
      "created_at": "2024-02-14T07:01:34.978Z",
      "updated_at": "2024-02-14T07:01:34.978Z",
      "project_number_string": "Test 1",
      "project_priority_index": 1,
      "id": "undefined"
    }
  ],
  "total_records": 1,
  "current_page": 1,
  "total_pages": 1
}