The HyperTrack API has the following entities. Use the links to find a detailed list of possible API calls for each one of them.
|User||Represents the person who is being tracked|
|Action||Represents a transaction event (e.g., pickup, delivery, visit, appointment, drop-off) being performed by the User|
|Place||Represents a place of interest that an User may visit, or where an Action is expected|
|Group||Represents a collection of Users|
|Geofence||Set a geofence to be notified when User enters or leaves certain place|
Every entity object created on HyperTrack has a unique identifier.
||Unique uuid4 identifier that is generated for every entity on HyperTrack|
||String identifier that you can specify while creating objects on HyperTrack. It is the unique identifier of the action in your system|
lookup_id enables get-or-create functionality for entities, with a 1-to-1 mapping between a lookup identifier and an entity. For example, a create user API call with an existing
lookup_id will return the previously created user with the same
To fetch the user entity with these identifiers, you can use the follow API conventions:
|Identifier||HTTP method||Request url|
The same conventions apply to Action, Group and Place entities.