Retrieve the details of one worker: contact information, pay settings, positions, locations and permissions. Put the Worker ID in the URL.
| Method | URL | API key permission | Package |
|---|---|---|---|
| GET | https://rental.software/api6/workers/{worker_id} | Workers: Read Only or Full Access | WP/API and Workers |
Request
GET /api6/workers/13687/?apiKey=YOUR_API_KEY
| Parameter | Where | Required | Description |
|---|---|---|---|
| worker_id | URL path | Yes | Numeric ID of the worker. Get IDs from API - Workers - Retrieve List |
| apiKey | Query string | Yes | Your API key |
Example using curl:
curl "https://rental.software/api6/workers/13687?apiKey=YOUR_API_KEY"
Response
{
"id": "13687",
"wuname": "jlee",
"regtime": "",
"modifiedtime": "2026-04-27T16:27:21-04:00",
"lastvisit": "",
"approved": "Yes",
"firstname": "Jamie",
"lastname": "Lee",
"address": "123 Main St",
"city": "Akron",
"state": "OH",
"zip": "44301",
"country": "United States",
"hphone": "(330) 555-0150",
"cphone": "(330) 555-0151",
"ophone": "",
"email": "jamie.lee@example.com",
"rank": "1",
"notes": "",
"payrate": "0.00",
"commission_percentage": "0.00",
"hideshifts": "0",
"mileagerate": "0.00",
"name": "Jamie Lee",
"leads": "write",
"customers": "write",
"workers": "write",
"calendar": "none",
"Leads_Delete": "write",
"locations": [
"9858",
"8777",
"12422"
],
"positionid": [
"6984"
],
"position_payrate": [
"0.00"
],
"positions": [
"Sales Rep"
],
"href": "https://rental.software/api6/workers/13687",
"regtime_ts": "0",
"regtime_utc": "",
"modifiedtime_ts": "1777321641",
"modifiedtime_utc": "2026-04-27T20:27:21Z",
"lastvisit_ts": "0",
"lastvisit_utc": "",
"request_time": 1760000000
}The example is shortened. A worker contains more fields than shown here, and your code should ignore fields it does not use.
How to Read the Response
| Field | Description |
|---|---|
| id, wuname | Worker ID and the worker's username |
| firstname, lastname, name | The worker's name |
| approved | Yes when the worker is approved (active) |
| address, city, state, zip, country | Address |
| hphone, cphone, ophone, email | Home, cell and office phone, and email |
| payrate, mileagerate, commission_ fields | Pay settings |
| locations | IDs of the locations the worker belongs to |
| positionid, positions, position_payrate | The worker's positions: their IDs, their names, and the pay rate of each |
| Permission fields such as leads, customers, workers | One field for each permission in your account, with the value none, read or write |
| href | URL of this worker in the API |
| regtime, modifiedtime, lastvisit | Dates in your account's time zone. Each also comes as a Unix timestamp (_ts) and in UTC (_utc). Empty when the date is not set |
Workers are read only through the API. They cannot be created, changed or deleted with it.
Errors
| Status | Message | What to do |
|---|---|---|
| 403 | Permission access restricted | Set Workers to Read Only or Full Access on the API key |
| 403 | Location access restricted | The worker belongs to locations the key cannot access |
| 404 | Worker not found | Check the Worker ID in the URL |
| 405 | Create/Update not implement for workers | Workers are read only. Use GET |
See API - Errors and Rate Limits for errors that apply to every call.