get
https://sandbox-api.softpoint.io/interface/v1/locations
Lists the locations accessible to a given user, returning a lightweight summary of each.
tions
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer YOUR_ACCESS_TOKEN |
Request Parameters
Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | integer | Yes | The current user id |
cURL Example
curl --request GET \
--url "https://sandbox-api.softpoint.io/interface/v1/locations?user_id=1" \
--header "Authorization: Bearer YOUR_ACCESS_TOKEN"
Success Response
The response is an array of location summaries.
[
{
"location_id": 59237,
"name": "Sunset Bistro",
"status": 1,
"location_id_external": "Rj82LgKq",
"timezone_code": "America/Phoenix",
"timezone_name": "(GMT-07:00) America, Phoenix"
},
{
"location_id": 48734,
"name": "Coastal Diner",
"status": 1
}
]
Response Fields
| Field | Type | Description |
|---|---|---|
| location_id | integer | Platform location identifier. |
| name | string | Location display name. |
| status | integer | Location status. |
| location_id_external | string | Your external identifier, if set. |
| timezone_code | string | IANA timezone code. |
| timezone_name | string | Human-readable timezone. |
Error Responses
Unauthorized / Token Expired
{
"error": {
"code": 10759,
"message": "Operation timed out. Please try again.",
"details": { "Exception": "Token has expired" }
}
}
Status Codes
| Code | Description |
|---|---|
| 200 | Locations returned |
| 401 | Token missing, expired, or invalid |
Workflow Placement
A read operation used to discover which locations a user can act on before drilling into a specific one.
Notes
-
The response is a bare array, not a paginator.
-
Refresh the token if you receive
10759.
Common Mistakes
-
Omitting the required
user_idquery parameter. -
Reusing an expired token (returns
10759).