The users api is the best way to retrieve data about individual users of your app. Users can be read or deleted using this endpoint.

idstringThe Taplytics id for this user
created_attimestampThe date and time this user was first seen
user_idstringThe custom user_id that you defined for this user
emailstringThe email address you have defined for this user
first_namestringThe first name you have defined for this user
last_namestringThe last name you have defined for this user
namestringThe full name you have defined for the user
custom_dataobjectThe custom data that you have defined for this user
last_seen_ipstringThe last seen ip address of this user
locationobjectThe last location info for this user
session_countintegerThe number of sessions this user has been a part of


A single User object with all its details, can be accessed via the appUser ID, Email or your custom User ID. If an email or custom User ID is provided in the URL parameters, the ID field can be omitted.

Creating the user: requires any of the following (user_id, email)
Updating the user: requires any of the following (id, user_id, email)


  • User creation will not show up instantly in the dashboard until the user that's created sends events that the dashboard tracks through an SDK.
  • The custom data can only be reliably kept with no more than one level of nesting, if the user currently has a custom data object and one is posted, the two will be merged.
  • While the custom data is appended immediately to the user, updating the custom data segmentation filter will have a requirement of > 100 events sent on a prod device or a couple of events sent on a dev device in order for the new custom data filter to appear.


(application/json; charset=utf-8)


    "id": "548223f2c7036020742ff21c",
    "created_at": "2015-01-06T03:51:57+00:00",
    "user_id": "42",
    "email": "[email protected]",
    "first_name": "Jonathan",
    "last_name": "Norris",
    "custom_data": {
        "occupation": "Bug Fixer",
        "favourite_color": "Chartreuse",
        "favourite movie": "You Don't Mess With The Zohan"
    "last_seen_ip": "",
    "location": {
        "city_name": "San Francisco",
        "continent_code": "NA",
        "country_code": "USA",
        "country_name": "United States",
        "latitude": 37.7749300,
        "longitude": -122.4194200,
        "postal_code": null,
        "region_name": "San Francisco",
        "timezone": "Europe/San Francisco"
    "session_count": 16,
    "gender": "male"