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 Group object
          • GET/groups
          • GET/groups/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsGroups

/groups/{id}

GET
/groups/:id
GET
/api/chat/v1/groups/:id
$curl -G https://api.merge.dev/api/chat/v1/groups/id \
>     -H "X-Account-Token: X-Account-Token" \
>     -H "Authorization: Bearer <token>" \
>     -d expand=users
200Retrieved
1{
2  "id": "c1f2d8a4-9f7a-4e2b-8e2f-123456789abc",
3  "remote_id": "121222",
4  "created_at": "2021-09-15T00:00:00Z",
5  "modified_at": "2021-10-16T00:00:00Z",
6  "name": "Engineering",
7  "users": [
8    "string"
9  ],
10  "remote_created_at": "2021-09-15T00:00:00Z",
11  "remote_updated_at": "2021-09-16T00:00:00Z",
12  "remote_was_deleted": true,
13  "field_mappings": {
14    "organization_defined_targets": {
15      "custom_key": "custom_value"
16    },
17    "linked_account_defined_targets": {
18      "custom_key": "custom_value"
19    }
20  },
21  "remote_data": [
22    {
23      "path": "/groups",
24      "data": null
25    }
26  ]
27}

Returns a Group object with the given id.

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

Was this page helpful?
Previous

/groups

Next

/account-details

Built with

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

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

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
namestring or null<=254 characters
The name of the Group
userslist of strings
remote_created_atdatetime or null
When the third party's group was created.
remote_updated_atdatetime or null
When the third party's group was updated.
remote_was_deletedbooleanRead-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