Skip to content

Galleries

Interfaces for getting gallery lists and images.

Get all public galleries.

Interface Information

  • Endpoint: GET /api/galleries
  • Authentication: Not required (public interface)

Get detailed information and image list for a specific gallery.

Interface Information

  • Endpoint: GET /api/galleries/:id
  • Authentication: Not required (public interface)

Path Parameters

ParameterTypeRequiredDescription
idnumberYesGallery ID

Response Fields

Field NameTypeDescription
idnumberGallery ID
titlestringGallery name
descriptionstringDescription
coverImagestringCover image URL
imagesarrayImage list
images[].idnumberImage ID
images[].urlstringImage URL
images[].thumbnailstringThumbnail URL

Request Example

bash
curl http://localhost:3000/api/galleries/1

Response Example

json
{
  "success": true,
  "data": {
    "id": 1,
    "title": "Photography Works",
    "description": "My photography portfolio",
    "coverImage": "https://example.com/cover.jpg",
    "images": [
      {
        "id": 1,
        "url": "https://example.com/image1.jpg",
        "thumbnail": "https://example.com/image1-thumb.jpg"
      }
    ]
  }
}

Error Responses

HTTP Status CodeDescription
404Gallery does not exist
500Server error