/conversations/{id}

Returns a Conversation 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.

namestring or null<=80 characters

The name of the conversation

descriptionstring or null

The description of the conversation.

urlstring or nullformat: "uri"<=2000 characters

The url of the conversation.

typeenum or null

The type of the conversation.

PRIVATE_INTERNAL - PRIVATE_INTERNAL
PRIVATE_EXTERNAL - PRIVATE_EXTERNAL
PUBLIC_INTERNAL - PUBLIC_INTERNAL
PUBLIC_EXTERNAL - PUBLIC_EXTERNAL
ONE_ON_ONE_CHAT - ONE_ON_ONE_CHAT
GROUP_CHAT - GROUP_CHAT
MEETING_CHAT - MEETING_CHAT

The type of the conversation. * `PRIVATE_INTERNAL` - PRIVATE_INTERNAL * `PRIVATE_EXTERNAL` - PRIVATE_EXTERNAL * `PUBLIC_INTERNAL` - PUBLIC_INTERNAL * `PUBLIC_EXTERNAL` - PUBLIC_EXTERNAL * `ONE_ON_ONE_CHAT` - ONE_ON_ONE_CHAT * `GROUP_CHAT` - GROUP_CHAT * `MEETING_CHAT` - MEETING_CHAT

memberslist of strings or null

remote_created_atdatetime or null

When the third party's conversation was created.

remote_updated_atdatetime or null

When the third party's conversation 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.

namestring or nullOptional<=80 characters

The name of the conversation

descriptionstring or nullOptional

The description of the conversation.

urlstring or nullOptionalformat: "uri"<=2000 characters

The url of the conversation.

typeenum or nullOptional

The type of the conversation.

PRIVATE_INTERNAL - PRIVATE_INTERNAL
PRIVATE_EXTERNAL - PRIVATE_EXTERNAL
PUBLIC_INTERNAL - PUBLIC_INTERNAL
PUBLIC_EXTERNAL - PUBLIC_EXTERNAL
ONE_ON_ONE_CHAT - ONE_ON_ONE_CHAT
GROUP_CHAT - GROUP_CHAT
MEETING_CHAT - MEETING_CHAT

memberslist of stringsOptional

remote_created_atdatetime or nullOptional

When the third party's conversation 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.

namestring or nullOptional<=80 characters

The name of the conversation

descriptionstring or nullOptional

The description of the conversation.

urlstring or nullOptionalformat: "uri"<=2000 characters

The url of the conversation.

typeenum or nullOptional

The type of the conversation.

PRIVATE_INTERNAL - PRIVATE_INTERNAL
PRIVATE_EXTERNAL - PRIVATE_EXTERNAL
PUBLIC_INTERNAL - PUBLIC_INTERNAL
PUBLIC_EXTERNAL - PUBLIC_EXTERNAL
ONE_ON_ONE_CHAT - ONE_ON_ONE_CHAT
GROUP_CHAT - GROUP_CHAT
MEETING_CHAT - MEETING_CHAT

memberslist of stringsOptional

remote_created_atdatetime or nullOptional

When the third party's conversation was created.

remote_datalist of objects or nullOptionalRead-only

1	import requests
2
3	url = "https://api.merge.dev/api/chat/v1/conversations/id"
4
5	querystring = {"expand":"members"}
6
7	headers = {
8	"X-Account-Token": "X-Account-Token",
9	"Authorization": "Bearer <token>"
10	}
11
12	response = requests.get(url, headers=headers, params=querystring)
13
14	print(response.json())

1	{
2	"id": "c2f2d8a4-9f7a-4e2b-8e2f-123456789abc",
3	"remote_id": "conv-001",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"name": "General Discussion",
7	"description": "A channel for general chat.",
8	"url": "https://example.com/conversations/conv-001",
9	"type": "PUBLIC_INTERNAL",
10	"members": [
11	"string"
12	],
13	"remote_created_at": "2021-09-15T00:00:00Z",
14	"remote_updated_at": "2021-09-16T00:00:00Z",
15	"remote_was_deleted": true,
16	"field_mappings": {
17	"organization_defined_targets": {
18	"custom_key": "custom_value"
19	},
20	"linked_account_defined_targets": {
21	"custom_key": "custom_value"
22	}
23	},
24	"remote_data": [
25	{
26	"path": "/conversations"
27	}
28	]
29	}

/conversations/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration