Get staff list of customer

This endpoint can return all the staffs' general data. And you can filter all there data by using the parameter "filter".

Get user list of customer

GET /get-user-list

You can retrieve information for all workers.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Required
Description

customer_id

string

The unique Marco identifier for your company.

pagination

json

Each page returns 50 records. By defualt, the first page data is returned. Example: {"page":2}

filter

json

If you want to filter user, you can use this parameter filter.user: use user's email for filter filter.status: filter user's status Valid values: Regular/Probation/Onboarding/Offboarded

Parameter Example:

{
  "customer_id": "1",
  "pagination": {
    "page": 1
  },
  "filter": {
    "home_country":"CN",
    "host_country":"IN",
    "status":"Regular"
  }
}

Response

{
    "itemsReceived": 1,
    "curPage": 1,
    "nextPage": null,
    "prevPage": null,
    "offset": 0,
    "itemsTotal": 1,
    "pageTotal": 1,
    "items": [
        {
            "id": 17,
            "name": "Nitin Boricha",
            "platform_email": "[email protected]",
            "status": "Regular",
            "job_title": "Unit Tester",
            "job_start_date": "2024-11-05",
            "host_country": "IN",
            "home_country": "CN"
        }
    ]
}

Last updated