containers

Retrieve

Returns a Container object with the given id.

get/knowledgebase/v1/containers/{id}

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/knowledgebase/v1/containers/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

expand'parent_article' | 'parent_article,parent_container' | 'parent_container' | 'permissions' | 'permissions,parent_article' | 'permissions,parent_article,parent_container' | 'permissions,parent_container'

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

include_remote_databoolean

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

include_shell_databoolean

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

Headers

X-Account-Tokenstring required

Token identifying the end user.

Response

idstring uuid
remote_idstring nullable

The third-party API ID of the matching object.

created_atstring date-time

The datetime that this object was created by Merge.

modified_atstring date-time

The datetime that this object was modified by Merge.

namestring nullable

Name of the container.

descriptionstring nullable

Description of the container.

status'DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'TRASH'
  • DRAFT - DRAFT
  • PUBLISHED - PUBLISHED
  • ARCHIVED - ARCHIVED
  • TRASH - TRASH
container_urlstring nullable

The URL to the webpage of the container.

type'FOLDER' | 'SPACE' | 'COLLECTION' | 'SECTION' | 'CATEGORY' | 'DATABASE'
  • FOLDER - FOLDER
  • SPACE - SPACE
  • COLLECTION - COLLECTION
  • SECTION - SECTION
  • CATEGORY - CATEGORY
  • DATABASE - DATABASE
visibility'PUBLIC' | 'INTERNAL' | 'RESTRICTED'
  • PUBLIC - PUBLIC
  • INTERNAL - INTERNAL
  • RESTRICTED - RESTRICTED
remote_created_atstring date-time nullable

When the third party's container was created.

remote_updated_atstring date-time nullable

When the third party's container was updated.

parent_articlestring uuid nullable

The parent article a container is nested within.

parent_containerstring uuid nullable

The parent container a container is nested within.

remote_was_deletedboolean

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_mappingsContainerFieldMappings

Changes

No recorded changes to this operation across all 1 revision of this API.