For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The User object
          • GET/users
          • GET/users/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsUsers

The User object

The User Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "username": "string",
7  "display_name": "string",
8  "first_name": "string",
9  "last_name": "string",
10  "is_bot": true,
11  "groups": [
12    "string"
13  ],
14  "avatar": "string",
15  "remote_created_at": "2023-01-01T00:00:00Z",
16  "remote_updated_at": "2023-01-01T00:00:00Z",
17  "remote_was_deleted": true,
18  "field_mappings": {},
19  "remote_data": [
20    {
21      "path": "string",
22      "data": {}
23    }
24  ]
25}
Was this page helpful?
Previous

/conversations/{conversation_id}/members

Next

/users

Built with

The User object is used to represent a user within the Chat account.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
usernamestring or nullOptional<=254 characters
Username or handle
display_namestring or nullOptional<=254 characters
Full name or display name
first_namestring or nullOptional<=254 characters
The user's first name
last_namestring or nullOptional<=254 characters
The user's last name
is_botboolean or nullOptional
Returns true if the user is a bot
groupslist of stringsOptional
avatarstring or nullOptionalformat: "uri"<=2000 characters
The user's avatar image
remote_created_atdatetime or nullOptional
When the third party's user was created.
remote_updated_atdatetime or nullOptional
When the third party's user was updated.
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only