ZUzuper

Get Users By Generic Filter

Changed on
post/users/filter

Request

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

Query parameters

limitinteger required
pageinteger required
sort_by''name'' | ''first_name'' | ''last_name'' | ''emp_code'' | ''created_at'' required
sort''DESC'' | ''ASC'' required

Request body

Response

200

typestring
total_recordsinteger
total_pagesinteger
current_pageinteger

Example response

{
  "type": "success",
  "data": [
    {
      "user_uid": "d3c3af3b-a082-49c4-bf87-01997eb4090d",
      "first_name": "FieldExecutive",
      "last_name": "Ashin",
      "email": "ashinthankachan1999@gmail.com",
      "external_login_id": "ashintest",
      "home_phone_number": "8301907278",
      "designation": "dev",
      "emp_code": "1111",
      "work_phone_number": "8301907278",
      "mobile_phone_number": "8301907278",
      "profile_picture": "https://s3.ap-south-1.amazonaws.com/prod.app.zuperpro/assets/profile_picture.jpg",
      "hourly_labor_charge": 120,
      "is_active": true,
      "created_at": "2022-07-15T03:28:47.000Z",
      "updated_at": "2023-06-09T06:03:30.000Z",
      "role": {
        "role_uid": "504e52bc-ff7d-11e7-8be5-0ed5f89f718b",
        "role_name": "Field Executive",
        "role_key": "FIELD_EXECUTIVE"
      },
      "access_role": {
        "access_role_uid": "411082db-bb1b-4bd6-b0d2-69867ca83655",
        "role_name": "Jobs",
        "role_description": "Test job"
      },
      "custom_fields": [
        {
          "label": "Zoho Employee Id",
          "type": "SINGLE_LINE",
          "_id": "62d0deefb8868766eea34377"
        }
      ]
    }
  ],
  "total_records": 5,
  "total_pages": 1,
  "current_page": 1
}

Changes