ZUzuper

Get Portals

Changed on
get/customer_portal

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/customer_portal
  • Auth
    API key in header x-api-key

Query parameters

pageinteger required
countinteger required
sort'DESC' | 'ASC'
sort_by'created_at' | 'portal_name'
filter.keywordstring
filter.is_activeboolean
filter.is_deletedboolean
filter.module'JOB' | 'CUSTOMER' | 'ESTIMATE' | 'INVOICE' | 'SERVICE_CONTRACT' | 'ASSET' | 'REQUEST'
filter.updated_at_fromstring date
filter.updated_at_tostring date

Response

200

typestring
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "portal_uid": "e1bd35a0-0063-11ee-b5cb-2d31ecfbc6c2",
      "portal_name": "Details page with FE details",
      "module": "JOB",
      "page": "DETAILS",
      "is_active": true,
      "created_by": {
        "user_uid": "06c18dad-1fcc-4278-a5f1-706ee0ca8b9e",
        "first_name": "Ajay",
        "last_name": "Ravi",
        "email": "ajay.r@zuper.co",
        "home_phone_number": "6369602168",
        "designation": "Software Engineer - product services",
        "emp_code": "132",
        "work_phone_number": "6369602168",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/34c45560-7f65-11ed-afd9-b91d9207a4f4.jfif",
        "hourly_labor_charge": 20,
        "is_active": true,
        "created_at": "2022-11-28T11:48:14.000Z",
        "updated_at": "2023-01-16T07:09:54.000Z"
      },
      "created_at": "2023-06-01T10:05:48.411Z",
      "updated_at": "2023-06-01T11:18:33.702Z",
      "id": "undefined"
    }
  ],
  "total_records": 2,
  "current_page": 1,
  "total_pages": 2
}

Changes