Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api-docs.hellotracks.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to retrieve member information for users in your organization. This returns the complete member object including profile details, location, status, role, and configuration.

​
REQUEST

POST https://api.hellotracks.com/api/getaccounts

{
  "data": {
    "uids": ["<uid-1>", "<uid-2>", "<uid-n>"]
  }
}
​
uids
array
Optional array of specific member UIDs to retrieve.
  • If provided: Returns only the specified members (subject to permissions)
  • If omitted: Returns yourself + all members you have permission to view (your organization/network)

​
Automatic Member Retrieval

When no uids are specified:
  • Personal accounts: Returns your own account
  • Company members: Returns your account + all members in your organization
  • Workers: May have restricted visibility based on company settings

​
Permissions

  • You can only retrieve members you have permission to view
  • Archived/suspended members can be retrieved if you have appropriate permissions
  • Workers may have limited access to other members based on company settings

​
RESPONSE

{
  "status": 0,
  "accounts": [
    {
      "uid": "abc123",
      "username": "worker@company.com",
      "name": "John Doe",
      "phone": "+14155551234",
      "email": "john@company.com",
      "role": "worker",
      "teams": [1, 2],
      "location": {
        "lat": 37.7749,
        "lng": -122.4194,
        "ts": 1634567890000,
        "accuracy": 10
      },
      "moving": "halted",
      "status_label": "Available",
      "color": "#22c328"
      // ... see Member Object for complete structure
    }
  ]
}
​
status
integer
required
Status code. 0 indicates success.
​
accounts
array
required
Array of member objects. Each member contains 55+ properties including:
  • Core identity (uid, username, name, phone, email)
  • Role and permissions (role, teams, active_status)
  • Real-time location and status
  • Working hours and availability
  • Device information
  • Configuration and preferences
See the Member API Object for complete field documentation.

​
Common Use Cases

Get all organization members: 
{
  "data": {}
}
Get specific members by UID: 
{
  "data": {
    "uids": ["worker1uid", "worker2uid", "worker3uid"]
  }
}
Check member status and location: Use this endpoint to get current location, battery level, and online status for field workers.
Complete Field Reference: See the Member API Object for documentation of all 55+ properties returned in each member object, including nested structures for location, device info, working hours, and more.
curl -X POST https://api.hellotracks.com/api/getaccounts \
  --header 'API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  -d '{
    "data": {}
  }'