get
https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID/users
Lists the dashboard users associated with a location, returning a paginated collection.
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer YOUR_ACCESS_TOKEN |
Request Parameters
Path Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| location_id | integer | Yes | Location whose users are listed. |
This endpoint takes no request body.
Request Example
No body is sent.
cURL Example
curl --request GET \
--url https://sandbox-api.softpoint.io/interface/v1/locations/4004699/users \
--header "Authorization: Bearer YOUR_ACCESS_TOKEN"
Success Response
The response is a paginator; data contains the user objects (truncated here to two entries).
{
"current_page": 1,
"data": [
{
"id": 1,
"first_name": "updated",
"last_name": "user",
"phone": null,
"email": "[email protected]",
"global_country_id": 3,
"created_datetime": "2021-12-17T00:53:33.000000Z"
},
{
"id": 2,
"first_name": "updated",
"last_name": "user 2",
"phone": "(789) 456-1230",
"email": "[email protected]",
"global_country_id": 3,
"created_datetime": "2022-01-06T19:13:08.000000Z"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
| current_page | integer | The page number returned. |
| data | array | List of user objects. |
| data[].id | integer | User ID. |
| data[].first_name | string | First name. |
| data[].last_name | string | Last name. |
| data[].phone | string | null |
| data[].email | string | Email address. |
| data[].global_country_id | integer | Associated country. |
| data[].created_datetime | string (ISO 8601) | Creation timestamp. |
Status Codes
| Code | Description |
|---|---|
| 200 | User list returned |
| 401 | Missing or invalid token |
Workflow Placement
A read operation used to enumerate or audit the users on an account.
Notes
- Results are paginated; iterate using the paginator's page fields when present.
Common Mistakes
-
Assuming the response is a bare array; the users are nested under
data. -
Calling with an expired token (returns
10759/401).