Business
The business this connection is for.
Needs the settings:read permission, depending on the operation. The business sees it as "Business details and locations".
Fields
| Field | Type | Access | Meaning |
|---|---|---|---|
| id | string | Read-only | The business. |
| name | string | Read-only | The business's name. |
| abn | string, may be null | Read-only | Australian Business Number. |
| pay_week_start_day | integer, may be null | Read-only | The day the pay week starts: 0 is Sunday, 6 is Saturday. A location can start its roster week on another day; see roster_week_start_day on locations. |
| awards | array of object | Read-only | The awards this business uses. |
| created_at | timestamp | Read-only | When the business was created. |
| updated_at | timestamp | Read-only | When the business last changed. |
Operations
Get the connected business
GET/v1/business
Permission: settings:read
{
"id": "66f1c2a4b3d9e8f7a6b5c4d3",
"name": "text",
"abn": "text",
"pay_week_start_day": 1,
"awards": [
{
"id": "66f1c2a4b3d9e8f7a6b5c4d3",
"code": "text",
"name": "text"
}
],
"created_at": "2026-10-06T09:00:00+11:00",
"updated_at": "2026-10-06T09:00:00+11:00"
}| Status | When |
|---|---|
| 400 | The error's code is invalid_request or range_too_long. The Errors page describes each code. |
| 401 | The error's code is invalid_token or token_expired. The Errors page describes each code. |
| 403 | The error's code is origin_not_allowed, permission_denied, not_available, connection_disconnected, connection_suspended or app_suspended. The Errors page describes each code. |
| 404 | There is nothing at this address, or no such record in this business. |
| 429 | Too many requests. Retry-After says when to try again. |
| 500 | Something went wrong at Shiftly. Quote the request id. |
| 503 | This environment is not set up for partner apps yet. |