/users/{id}

Returns a User object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

The datetime that this object was created by Merge.

modified_atdatetime or nullRead-only

The datetime that this object was modified by Merge.

usernamestring or null<=254 characters

Username or handle

display_namestring or null<=254 characters

Full name or display name

first_namestring or null<=254 characters

The user's first name

last_namestring or null<=254 characters

The user's last name

is_botboolean or null

Returns true if the user is a bot

groupslist of strings or null

avatarstring or nullformat: "uri"<=2000 characters

The user's avatar image

remote_created_atdatetime or null

When the third party's user was created.

remote_updated_atdatetime or null

When the third party's user was updated.

remote_was_deletedboolean or nullRead-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 nullRead-only

remote_datalist of objects or nullRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

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

remote_created_atdatetime or nullOptional

When the third party's user was created.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

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

remote_created_atdatetime or nullOptional

When the third party's user was created.

remote_datalist of objects or nullOptionalRead-only

1	using RestSharp;
2
3	var client = new RestClient("https://api.merge.dev/api/chat/v1/users/id?expand=groups");
4	var request = new RestRequest(Method.GET);
5	request.AddHeader("X-Account-Token", "X-Account-Token");
6	request.AddHeader("Authorization", "Bearer <token>");
7	IRestResponse response = client.Execute(request);

1	{
2	"id": "a1234567-89ab-cdef-0123-456789abcdef",
3	"remote_id": "77431241242",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"username": "alice",
7	"display_name": "Alice Smith",
8	"first_name": "Alice",
9	"last_name": "Smith",
10	"is_bot": true,
11	"groups": [
12	"string"
13	],
14	"avatar": "https://merge.dev/user_profile_pic.png",
15	"remote_created_at": "2021-09-15T00:00:00Z",
16	"remote_updated_at": "2021-09-16T00:00:00Z",
17	"remote_was_deleted": true,
18	"field_mappings": {
19	"organization_defined_targets": {
20	"custom_key": "custom_value"
21	},
22	"linked_account_defined_targets": {
23	"custom_key": "custom_value"
24	}
25	},
26	"remote_data": [
27	{
28	"path": "/users"
29	}
30	]
31	}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration