Common ModelsContainers

/containers/{id}

Returns a Container object with the given id.

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.
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<=254 characters
Name of the container.
descriptionstring or null<=2000 characters
Description of the container.
statusenum or null
The container's status. * `DRAFT` - DRAFT * `PUBLISHED` - PUBLISHED * `ARCHIVED` - ARCHIVED * `TRASH` - TRASH
Allowed values:
container_urlstring or null<=2000 characters
The URL to the webpage of the container.
typeenum or null
The container's type. * `FOLDER` - FOLDER * `SPACE` - SPACE * `COLLECTION` - COLLECTION * `SECTION` - SECTION * `CATEGORY` - CATEGORY * `DATABASE` - DATABASE
visibilityenum or null
The container's visibility. * `PUBLIC` - PUBLIC * `INTERNAL` - INTERNAL * `RESTRICTED` - RESTRICTED
Allowed values:
remote_created_atdatetime or null
When the third party's container was created.
remote_updated_atdatetime or null
When the third party's container was updated.
parent_articlestring or nullformat: "uuid"
The parent article a container is nested within.
parent_containerstring or nullformat: "uuid"
The parent container a container is nested within.
permissionslist of objects or null
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](https://docs.merge.dev/integrations/hris/supported-features/).
field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only