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 Container object
          • GET/containers
          • GET/containers/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsContainers

The Container object

The Container 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  "name": "string",
7  "description": "string",
8  "status": "DRAFT",
9  "container_url": "string",
10  "type": "FOLDER",
11  "visibility": "PUBLIC",
12  "remote_created_at": "2023-01-01T00:00:00Z",
13  "remote_updated_at": "2023-01-01T00:00:00Z",
14  "parent_article": "string",
15  "parent_container": "string",
16  "permissions": [
17    {
18      "id": "string",
19      "remote_id": "string",
20      "created_at": "2023-01-01T00:00:00Z",
21      "modified_at": "2023-01-01T00:00:00Z",
22      "user": "string",
23      "group": "string",
24      "type": "USER",
25      "roles": [
26        "READ"
27      ],
28      "remote_was_deleted": true,
29      "field_mappings": {}
30    }
31  ],
32  "remote_was_deleted": true,
33  "field_mappings": {},
34  "remote_data": [
35    {
36      "path": "string",
37      "data": {}
38    }
39  ]
40}
Was this page helpful?
Previous

/attachments/{id}

Next

/containers

Built with

The Container object is used to represent a grouping of articles in the knowledge base. This can include Spaces, Folders, Databases, etc.

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.
namestring or nullOptional<=254 characters
Name of the container.
descriptionstring or nullOptional<=2000 characters
Description of the container.
statusenum or nullOptional

The container's status.

  • DRAFT - DRAFT
  • PUBLISHED - PUBLISHED
  • ARCHIVED - ARCHIVED
  • TRASH - TRASH
Allowed values:
container_urlstring or nullOptional<=2000 characters
The URL to the webpage of the container.
typeenum or nullOptional

The container's type.

  • FOLDER - FOLDER
  • SPACE - SPACE
  • COLLECTION - COLLECTION
  • SECTION - SECTION
  • CATEGORY - CATEGORY
  • DATABASE - DATABASE
visibilityenum or nullOptional

The container's visibility.

  • PUBLIC - PUBLIC
  • INTERNAL - INTERNAL
  • RESTRICTED - RESTRICTED
Allowed values:
remote_created_atdatetime or nullOptional
When the third party's container was created.
remote_updated_atdatetime or nullOptional
When the third party's container was updated.
parent_articlestring or nullOptionalformat: "uuid"
The parent article a container is nested within.
parent_containerstring or nullOptionalformat: "uuid"
The parent container a container is nested within.
permissionslist of objectsOptional
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