Retrieve a paged list of the workers in your account. Use it to sync your staff into another system, or to look up Worker IDs for other API calls.
| Method | URL | API key permission | Package |
|---|---|---|---|
| GET | https://rental.software/api6/workers | Workers: Read Only or Full Access | WP/API and Workers |
Request
GET /api6/workers/?apiKey=YOUR_API_KEY&offset=0&limit=2
| Parameter | Default | Description |
|---|---|---|
| apiKey | Required. Your API key | |
| _body | false | If true, returns more details for each worker: the full name, permissions, locations and positions. The request may take a little longer |
| offset | 0 | Record number to start at. The first record is 0 |
| limit | 25 | Count of records to return |
| approved | 1 | 1 returns only approved workers. 0 returns only workers that are not approved |
| vehicle | 0 | Send 1 to return vehicles instead of workers |
Example using curl:
curl "https://rental.software/api6/workers?apiKey=YOUR_API_KEY&offset=0&limit=2"
Response
{
"offset": 0,
"limit": "2",
"first": "https://rental.software/api6/workers?offset=0&limit=2",
"next": "https://rental.software/api6/workers?offset=2&limit=2",
"previous": "https://rental.software/api6/workers?offset=0&limit=2",
"items": [
{
"id": "2",
"wuname": "pjordan",
"regtime": "2024-09-04T13:52:44-04:00",
"modifiedtime": "",
"lastvisit": "2026-02-02T18:19:23-05:00",
"approved": "Yes",
"firstname": "Pat",
"lastname": "Jordan",
"address": "1234 Woodlawn Rd.",
"city": "Akron",
"state": "OH",
"zip": "44306",
"country": "",
"hphone": "(330) 555-0123",
"cphone": "",
"ophone": "",
"email": "pat.jordan@example.com",
"rank": "1",
"notes": "",
"payrate": "16.50",
"commission_percentage": "0.00",
"hideshifts": "0",
"mileagerate": "0.00",
"href": "https://rental.software/api6/workers/2",
"regtime_ts": "1725472364",
"regtime_utc": "2024-09-04T17:52:44Z",
"modifiedtime_ts": "",
"modifiedtime_utc": "",
"lastvisit_ts": "1770074363",
"lastvisit_utc": "2026-02-02T23:19:23Z"
},
{
"id": "546",
"wuname": "kspeed",
"regtime": "",
"modifiedtime": "",
"lastvisit": "",
"approved": "Yes",
"firstname": "Kim",
"lastname": "Speed",
"address": "",
"city": "",
"state": "OH",
"zip": "",
"country": "",
"hphone": "(330) 555-0132",
"cphone": "",
"ophone": "",
"email": "kim.speed@example.com",
"rank": "4",
"notes": "",
"payrate": "19.00",
"commission_percentage": "0.00",
"hideshifts": "0",
"mileagerate": "0.00",
"href": "https://rental.software/api6/workers/546",
"regtime_ts": "0",
"regtime_utc": "",
"modifiedtime_ts": "",
"modifiedtime_utc": "",
"lastvisit_ts": "0",
"lastvisit_utc": ""
}
],
"request_time": 1760000000
}The example is shortened. Each worker contains more fields than shown here, and your code should ignore fields it does not use.
Good to Know
- Workers are sorted by last name, then first name.
- API keys are not included in this list.
- If the API key is limited to certain locations, only workers assigned to those locations are returned.
- The first, next and previous links do not include your API key. Add it before calling one.
- The next link is always present, even on the last page. Stop paging when a page comes back with fewer items than your limit. A request past the end returns HTTP 404.
Errors
| Status | Message | What to do |
|---|---|---|
| 403 | Permission access restricted | Set Workers to Read Only or Full Access on the API key |
| 404 | No workers found | Nothing matched, or you paged past the end of the list |
| 405 | Only accepts GET requests | Use GET |
See API - Errors and Rate Limits for errors that apply to every call.