To help manage large result sets, we support pagination on a number of our endpoints. You can paginate the results by passing _page_number and _page_size in the query.

KeyDescriptionDefault Value
_page_numberRepresents a page in the set of results for the current filter and sort order1
_page_sizeThe number of results to be returned per page20

Example Request

curl 'https://cloud.eastridge.com/api/client/workers?state=active&_page_number=1&_page_size=20&_order=-start_date' -H 'auth-token: 1c0c9f8716821c981606cbacab1a1599c487f46e303bfc6702f17a8fb89da687'

Example Response

{
  "meta": {
    "page_number": 1,
    "page_size": 20,
    "total": 113
  },
  "status": "ok",
  "results": [
    {
      "actual_end_date": null,
      "actual_start_date": "2016-05-16",
      "assignment_state": "Active",
      "base_rate": 10.0,
      "email": "[email protected]",
      "client_departments": "Marketing",
      "client_label": "Westcorp Inc.",
      "client_locations": [
        {
          "client_id": 250005,
          "description": null,
          "id": 250022,
          "label": "1630 Main St.",
          "tz_name": "America/Los_Angeles",
          "state": "active"
        }
      ],
      "client_order_assignment_ext_ats_ref": "AS000215805",
      "client_order_assignment_id": 251865,
      "client_order_custom_fields": {},
      "client_order_id": 250123,
      "client_order_type": "payrolling",
      "dt_hours": 6.5,
      "effective_bill_rate": 11.75,
      "email": "[email protected]",
      "end_cause": null,
      "end_cause_label": null,
      "end_cause_notes": "",
      "ext_ats_ref": "KSU038428882",
      "ext_order_ref": "",
      "hiring_manager": "Jane Williams",
      "id": 250215,
      "label": "John Smith",
      "markup": 0.175,
      "name_first": "John",
      "name_last": "Smith",
      "offer_end_date": "2016-12-16",
      "offer_start_date": "2016-05-16",
      "ot_hours": 59.0,
      "ot_rate": 15.0,
      "phone": null,
      "po_ref": null,
      "position_id": 250765,
      "position_label": "Marketing Coordinator",
      "reg_hours": 1504.5,
      "state_label": "Active",
      "supplier_label": "Eastridge Payrolling",
      "supplier_worker_id": 250263,
      "tentative_end_date": "2016-12-16",
      "timetracking_client_pay_scheme_label": "CA non-exempt weekly",
      "total_hours": 1570.0,
      "work_from_home": false,
      "worker_id": 250215,
    },
    ...
  ]
}