Create a folder
https://am-api.contentstack.com/api/spaces/{space_uid}/foldersThe Create a folder request creates a new folder in the specified space. To create a subfolder, pass the uid of the parent folder in the request body.
{
"title": "string",
"description": "string",
"parent_uid": "string"
}{
"notice": "string",
"folder": {
"_id": "string",
"uid": "string",
"object_type": "string",
"title": "string",
"description": "string",
"file_name": "string",
"parent_uid": "string",
"path": [
{
"uid": "string",
"title": "string"
}
],
"owner_uid": "string",
"co_owners": [
{
"uid": "string",
"name": "string"
}
],
"permanent_url": "string",
"permanent_url_slug": "string",
"content_type": "string",
"asset_type_uid": "string",
"file_size": 0,
"tags": [
"string"
],
"is_dir": true,
"asset_id": "string",
"url": "string",
"locale": "string",
"dimensions": {
"height": 0,
"width": 0
},
"status": "IN_PROGRESS",
"version": 0,
"org_uid": "string",
"space_uid": "string",
"user_defined_fields": {},
"visual_markups": [
{
"type": "Hotspot",
"title": "string",
"description": "string",
"url": "http://example.com",
"coordinates": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
}
}
],
"publish_details": [
{
"locale": "string",
"environment": "string",
"time": "2019-08-24T14:15:22Z",
"user": "string",
"version": 0,
"action": "string",
"job_id": "string",
"scheduled_at": "2019-08-24T14:15:22Z",
"workspace_uid": "string",
"origin": "string"
}
],
"_version_name": {
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string"
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_deleted": true
}
}Get all folders
https://am-api.contentstack.com/api/spaces/{space_uid}/foldersThe Get all folders request fetches a paginated list of all folders in the specified space.
{
"count": 0,
"relation": "string",
"folders": [
{
"_id": "string",
"uid": "string",
"object_type": "string",
"title": "string",
"description": "string",
"file_name": "string",
"parent_uid": "string",
"path": [
{
"uid": "string",
"title": "string"
}
],
"owner_uid": "string",
"co_owners": [
{
"uid": "string",
"name": "string"
}
],
"permanent_url": "string",
"permanent_url_slug": "string",
"content_type": "string",
"asset_type_uid": "string",
"file_size": 0,
"tags": [
"string"
],
"is_dir": true,
"asset_id": "string",
"url": "string",
"locale": "string",
"dimensions": {
"height": 0,
"width": 0
},
"status": "IN_PROGRESS",
"version": 0,
"org_uid": "string",
"space_uid": "string",
"user_defined_fields": {},
"visual_markups": [
{
"type": "Hotspot",
"title": "string",
"description": "string",
"url": "http://example.com",
"coordinates": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
}
}
],
"publish_details": [
{
"locale": "string",
"environment": "string",
"time": "2019-08-24T14:15:22Z",
"user": "string",
"version": 0,
"action": "string",
"job_id": "string",
"scheduled_at": "2019-08-24T14:15:22Z",
"workspace_uid": "string",
"origin": "string"
}
],
"_version_name": {
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string"
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_deleted": true
}
]
}Restore a deleted folder
https://am-api.contentstack.com/api/spaces/{space_uid}/folders/{folder_uid}/restoreThe Restore a deleted folder request restores a soft-deleted folder. Set restore_with_assets to true to also restore the assets that the folder contained.
{
"notice": "string",
"asset": {
"_id": "string",
"uid": "string",
"object_type": "string",
"title": "string",
"description": "string",
"file_name": "string",
"parent_uid": "string",
"path": [
{
"uid": "string",
"title": "string"
}
],
"owner_uid": "string",
"co_owners": [
{
"uid": "string",
"name": "string"
}
],
"permanent_url": "string",
"permanent_url_slug": "string",
"content_type": "string",
"asset_type_uid": "string",
"file_size": 0,
"tags": [
"string"
],
"is_dir": true,
"asset_id": "string",
"url": "string",
"locale": "string",
"dimensions": {
"height": 0,
"width": 0
},
"status": "IN_PROGRESS",
"version": 0,
"org_uid": "string",
"space_uid": "string",
"user_defined_fields": {},
"visual_markups": [
{
"type": "Hotspot",
"title": "string",
"description": "string",
"url": "http://example.com",
"coordinates": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
}
}
],
"publish_details": [
{
"locale": "string",
"environment": "string",
"time": "2019-08-24T14:15:22Z",
"user": "string",
"version": 0,
"action": "string",
"job_id": "string",
"scheduled_at": "2019-08-24T14:15:22Z",
"workspace_uid": "string",
"origin": "string"
}
],
"_version_name": {
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string"
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_deleted": true
}
}Update a folder
https://am-api.contentstack.com/api/spaces/{space_uid}/folders/{folder_uid}The Update a folder request updates the details of a specific folder, such as its title or parent folder.
{
"title": "string",
"description": "string",
"parent_uid": "string"
}{
"notice": "string",
"folder": {
"_id": "string",
"uid": "string",
"object_type": "string",
"title": "string",
"description": "string",
"file_name": "string",
"parent_uid": "string",
"path": [
{
"uid": "string",
"title": "string"
}
],
"owner_uid": "string",
"co_owners": [
{
"uid": "string",
"name": "string"
}
],
"permanent_url": "string",
"permanent_url_slug": "string",
"content_type": "string",
"asset_type_uid": "string",
"file_size": 0,
"tags": [
"string"
],
"is_dir": true,
"asset_id": "string",
"url": "string",
"locale": "string",
"dimensions": {
"height": 0,
"width": 0
},
"status": "IN_PROGRESS",
"version": 0,
"org_uid": "string",
"space_uid": "string",
"user_defined_fields": {},
"visual_markups": [
{
"type": "Hotspot",
"title": "string",
"description": "string",
"url": "http://example.com",
"coordinates": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
}
}
],
"publish_details": [
{
"locale": "string",
"environment": "string",
"time": "2019-08-24T14:15:22Z",
"user": "string",
"version": 0,
"action": "string",
"job_id": "string",
"scheduled_at": "2019-08-24T14:15:22Z",
"workspace_uid": "string",
"origin": "string"
}
],
"_version_name": {
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string"
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_deleted": true
}
}Get a folder
https://am-api.contentstack.com/api/spaces/{space_uid}/folders/{folder_uid}The Get a folder request fetches the details of a specific folder using its uid.
{
"folder": {
"_id": "string",
"uid": "string",
"object_type": "string",
"title": "string",
"description": "string",
"file_name": "string",
"parent_uid": "string",
"path": [
{
"uid": "string",
"title": "string"
}
],
"owner_uid": "string",
"co_owners": [
{
"uid": "string",
"name": "string"
}
],
"permanent_url": "string",
"permanent_url_slug": "string",
"content_type": "string",
"asset_type_uid": "string",
"file_size": 0,
"tags": [
"string"
],
"is_dir": true,
"asset_id": "string",
"url": "string",
"locale": "string",
"dimensions": {
"height": 0,
"width": 0
},
"status": "IN_PROGRESS",
"version": 0,
"org_uid": "string",
"space_uid": "string",
"user_defined_fields": {},
"visual_markups": [
{
"type": "Hotspot",
"title": "string",
"description": "string",
"url": "http://example.com",
"coordinates": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
}
}
],
"publish_details": [
{
"locale": "string",
"environment": "string",
"time": "2019-08-24T14:15:22Z",
"user": "string",
"version": 0,
"action": "string",
"job_id": "string",
"scheduled_at": "2019-08-24T14:15:22Z",
"workspace_uid": "string",
"origin": "string"
}
],
"_version_name": {
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string"
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_deleted": true
}
}Delete a folder
https://am-api.contentstack.com/api/spaces/{space_uid}/folders/{folder_uid}The Delete a folder request deletes a specific folder using its uid. Deleting a folder also affects the assets and subfolders it contains.
{
"notice": "string",
"uid": "string",
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string"
}