Get Content Folder

Get content folder

GET/organizations/{organizationId}/folders/{id}

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Content Folder action (under Shopper Experience).
Fill in the fields below, then reference the result from later steps as {{getContentFolder.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

idstringrequired

Identifier for the requested content folder.

Query parameters

levelsinteger

Specifies how many levels of nested subfolders you want the server to return. The default value is 1. Valid values are 0, 1, or 2.

Default 1

siteIdstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

localeoneOf

A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.

Response

Returns 200 with an object. Read it in later steps with {{getContentFolder.response.data.<field>}}.

idstring

The id of the content folder.

parentFolderIdstring

The id of the parent content folder.

namestring

The localized content folder name.

descriptionstring

The localized content folder description.

pageDescriptionstring

The localized content folder page description.

pageKeywordsstring

The localized content folder page keywords.

pageTitlestring

The localized content folder page title.

foldersarray<object>

The array of content subfolders. This array can be empty.

json

{
  "id": "homepage-folder",
  "parentFolderId": "root-folder",
  "name": "Homepage Folder",
  "description": "Folder containing homepage content assets",
  "pageDescription": "SEO description for homepage folder",
  "pageKeywords": "homepage, main, landing",
  "pageTitle": "Homepage Folder - My Store",
  "folders": [
    {}
  ]
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?