User Object

Represents a nandbox user or bot account. You receive it when your bot is an admin on the app, and in the response to getUser.

💡 Which fields are populated depends on where the object came from. terminal and type appear only inside an incoming Message; is_bot, status, and photo only in getUser.

Fields

Field	Type	Required	Description
`id`	String	Conditional	The user or bot. Not sent for `getMyProfile` / `setMyProfile`, which already know who you are.
`name`	String	Optional	Display name.
`short_name`	String	Optional	Shortened display name.
`signup_id`	String	Optional	The signup identity — mobile number or email, depending on how the app is configured.
`profile`	String	Optional	`"Other"`, `"Friend"`, `"Work"`, or `"Family"`. Defaults to `"other"` when absent.
`version`	String	Optional	Version stamp of the last profile update.
`terminal`	String	Optional	`"Mobile"` or `"API"`. Only inside an incoming Message.
`type`	String	Optional	`"Contact"` for a person, `"Bot"` for a bot. Only inside an incoming Message.
`is_bot`	Boolean	Optional	`true` if this account is a bot. Only in getUser.
`status`	String	Optional	The user's status text. Only in getUser.
`last_seen`	String	Optional	When the user was last active.
`photo`	Photo	Optional	Profile photo, with a thumbnail. Only in getUser.

The wire object may also carry an image field holding the profile picture inline as base64. It is not exposed by any SDK — use photo and download the media instead.

Example

The image value is a multi-kilobyte base64 string; it is truncated here.

json
{
  "user": {
    "id": "90089584980037358",
    "name": "Henry Bell",
    "is_bot": false,
    "version": "00KH",
    "status": "click for help",
    "photo": {
      "id": "V_0rbN_90089584980037358_0_Fcs3Z4qxaq.jpg",
      "width": 120,
      "height": 256,
      "thumbnail": {
        "id": "V_0rbN_90089584980037358_0_Fcs3Z4qxaq.jpg.thumb.jpg",
        "width": 120,
        "height": 256
      }
    },
    "image": "/9j/4AAQSkZJRgABAQAAAQABAAD…"
  }
}