Gallery

List gallery folders

Lists the folders directly inside a given folder. By default (parentFolderId omitted) this is the top level of the gallery as this project sees it: this project's own top-level folders, PLUS any account-wide shared folder (one with no project of its own, e.g. "Company Logos" - visible to and usable from every project in the account). The project's own top level has no folder entry of its own - the response's galleryName field carries its name (the project name). Pass parentFolderId to list a subfolder's contents instead, which can be inside either your own tree or a shared one - but never inside a different project's own private tree.

get/v1/projectId/{projectId}/gallery/folders

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/gallery/folders
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

Query parameters

parentFolderIdstring

A folder _id to list the children of. Omit to list the top-level folders.

limitinteger

Max items per page. Capped at 30.

skipinteger

Number of items to skip, for pagination.

sort'name' | 'createdAt' | 'updatedAt'

Field to sort by.

order'asc' | 'desc'
filter[<field>]string

Exact-match filter on a top-level field, e.g. filter[name]=Welcome. Repeatable for multiple fields.

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

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