Overview
An API user is a set of credentials that an operator uses to authenticate with the Uptrends API. API users are separate from an operator’s Uptrends login credentials, so you can use them in scripts, integrations, and automation without exposing account passwords.
Each operator can have multiple API users, each with its own username, password, and access type. The access type identifies the client or application that uses the credentials. For example, Generic for scripts and automation, MobileApp for the Uptrends mobile app, or TransactionRecorder for Uptrends Transaction Recorder.
Use cases
- Manage an operator’s API credentials — create, update, and delete API users including username, password, and API access type programmatically.
- Retrieve API user details to track API activity and control access — manage usage details such as when credentials were last used or how many requests were made in the last 30 days.
Prerequisites
Before using the ApiUser API, make sure you have:
ApiUser API endpoints
The ApiUser API exposes the following endpoints for managing API information:
| Method | Endpoint | Description |
|---|---|---|
GET |
/ApiUser |
Returns a list of all API users in the account. |
POST |
/ApiUser |
Creates a new API user for an operator. In the request body, provide only OperatorGuid and Description. All other fields are read-only or assigned by the API. |
GET |
/ApiUser/Operator/{operatorGuid} |
Returns a list of API users of the specified operator. |
GET |
/ApiUser/{apiUserGuid} |
Returns details for the specified API user, including the operator GUID, username, access type, and last-used date. |
PUT |
/ApiUser/{apiUserGuid} |
Updates the specified API user. In the request body, provide only OperatorGuid and Description. Only Description can be updated. The OperatorGuid associated to the API user must remain unchanged. |
DELETE |
/ApiUser/{apiUserGuid} |
Deletes the specified API user. |
For detailed request and response formats, and interactive API testing, refer to the Uptrends ApiUser API documentation.
ApiUser API examples
GET response
Example response for GET /ApiUser:
[
{
"ApiUserGuid": "c1534087-590e-497e-b58e-00bc4dbfa1d3",
"OperatorGuid": "ab12345c-0d8e-46a2-acef-dd1e15571097",
"UserName": "c1534087590e497eb58e00bc4dbfa1d3",
"Type": "Generic",
"Description": "Transaction Recorder",
"CreatedDate": "2025-11-11T21:18:01",
"LastUsed": "25/06/2026 19:37:59",
"UsageLast30Days": 17706
}
]
GET /ApiUser/{apiUserGuid} returns a single object with the same fields, not an array.
POST request body
Example request body for POST /ApiUser:
{
"OperatorGuid": "ef45547g-0f8h-46a2-acef-dd1e15571390",
"Description": "API description"
}
The OperatorGuid must match the existing API user. A successful update returns 204 No content.
PUT request body
Example request body for PUT /ApiUser/{apiUserGuid}:
{
"OperatorGuid": "ef45547g-0f8h-46a2-acef-dd1e15571390",
"Description": "Updated API description"
}
A successful update returns 204 No Content.
ApiUser API parameters
| Field name | Description |
|---|---|
OperatorGuid |
Path parameter. The GUID of the operator whose API users you want to retrieve. |
ApiUserGuid |
Path parameter. The GUID of the API user to retrieve, update, or delete. |
ApiUser API fields
Note
Some ApiUser fields are read-only or automatically assigned by the API.
ApiUser resources use the following properties in request and response bodies:
| Field name | Description |
|---|---|
ApiUserGuid |
The unique identifier of the API user. Assigned automatically when an API user is created. |
OperatorGuid |
The unique identifier of the operator associated with this API user. Required in POST and PUT request bodies. You cannot change the OperatorGuid of an existing API user in a PUT request. |
UserName |
The username used with the password to authenticate API requests. Automatically assigned when an API user is created. Read-only. |
Password |
The password used with the username to authenticate API requests. Automatically assigned when an API user is created. Omitted from GET responses. Not included in POST or PUT request bodies. |
Type |
Identifies the client or application that uses the API credentials. Automatically assigned by the API. Read-only.
|
Description |
Details of the API user. For example, Transaction Recorder or Private Location healthchecks. |
CreatedDate |
The date and time when the API user was created. Read-only. |
LastUsed |
The date and time of the last API request. Read-only. |
UsageLast30Days |
Number of requests made in the last 30 days. Read-only. |
Troubleshooting
This section covers common HTTP errors and troubleshooting steps for the ApiUser API.
Common errors
Common HTTP status codes and their descriptions:
| Status Code | Description |
|---|---|
| 200 | OK — request successful. |
| 201 | Created — the API user was created successfully. The response body contains the new API user, including the assigned ApiUserGuid. |
| 204 | No content — the request completed successfully and no response body was returned. This applies to successful PUT and DELETE requests. |
| 400 | Bad request — invalid request parameters or missing required fields.
|
| 401 | Unauthorized — invalid or missing authentication credentials. |
| 403 | Forbidden — one or more validation errors occurred. This may be related to account permissions. |
| 404 | Not Found — the specified operatorGuid or apiUserGuid was not found. |
| 500 | Internal Server Error — a server-side error occurred. |
General troubleshooting guide
Ensure that you:
- Always validate your request data before sending API calls.
- Use appropriate HTTP methods for each operation.
For further assistance, please reach out to our Support team.
Related articles
For more details, refer to the following articles:
- Uptrends ApiUser API documentation — interactive API documentation with detailed endpoint specifications.
- API changelog — latest API updates and deprecation notices.