get
https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID/users/22
Fetches a single dashboard user by ID, returning their current profile.
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer YOUR_ACCESS_TOKEN |
Request Parameters
Path Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| location_id | integer | Yes | Location the user belongs to. |
| user_id | integer | Yes | ID of the user to retrieve. |
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/94 \
--header "Authorization: Bearer YOUR_ACCESS_TOKEN"
Success Response
{
"id": 94,
"first_name": "Test User",
"last_name": "Doe",
"phone": "+1 (123) 456-7898",
"email": "[email protected]",
"global_country_id": 3,
"created_datetime": "2023-03-07T19:05:52.000000Z"
}
Response Fields
| Field | Type | Description |
|---|---|---|
| id | integer | The user's ID. |
| first_name | string | First name. |
| last_name | string | Last name. |
| phone | string | Normalized phone number, or null if none. |
| string | Email address. | |
| global_country_id | integer | Associated country. |
| created_datetime | string (ISO 8601) | Creation timestamp. |
Error Responses
User Not Found
{
"error": {
"code": 10201,
"message": "The selected user doesn't exist.",
"details": null
}
}
Status Codes
| Code | Description |
|---|---|
| 200 | User returned |
| 404 | User does not exist |
Workflow Placement
A read operation used any time after a user has been created.
Notes
- The
user_idis supplied as a path parameter; no request body is required.
Common Mistakes
-
Passing the user ID in the body instead of the path.
-
Requesting an ID that does not exist (returns
10201).