Connection
The link between your app and one business. Every access credential belongs to exactly one.
Available to every connection.
Fields
| Field | Type | Access | Meaning |
|---|---|---|---|
| id | string | Read-only | The connection. |
| state | "active", "reduced" | Read-only | active, or reduced when the person who connected the app no longer holds everything it was given. |
| business_id | string | Read-only | The connected business. |
| business_name | string | Read-only | The connected business's name. |
| granted_permissions | array of string | Read-only | What the business allowed. |
| effective_permissions | array of string | Read-only | What the app can use right now. |
| connected_at | timestamp | Read-only | When the business connected the app. |
Operations
Get this connection
GET/v1/connection
Permission: any
{
"id": "66f1c2a4b3d9e8f7a6b5c4d3",
"state": "active",
"business_id": "66f1c2a4b3d9e8f7a6b5c4d3",
"business_name": "text",
"granted_permissions": [
"text"
],
"effective_permissions": [
"text"
],
"connected_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. |