Gallery

List gallery images

Lists the images directly inside a given folder - by default the top level of this project's own gallery (whose name is in the response's galleryName field). Pass parentFolderId to list a subfolder's contents instead.

get/v1/projectId/{projectId}/gallery/images

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/gallery/images
  • 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 images inside. Omit to list the top-level images.

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.