Jump to content

REST API Documentation

/gallery/images


Get list of images

For requests using an OAuth Access Token for a particular member, only images the authorized user can view will be included


Parameters

Name Type Description
ids string Comma-delimited list of image IDs
categories string Comma-delimited list of category IDs (will also include images in albums in those categories)
albums string Comma-delimited list of album IDs
authors string Comma-delimited list of member IDs - if provided, only images started by those members are returned
locked int If 1, only images which are locked are returned, if 0 only unlocked
hidden int If 1, only images which are hidden are returned, if 0 only not hidden
featured int If 1, only images which are featured are returned, if 0 only not featured
sortBy string What to sort by. Can be 'date' for creation date, 'title', 'updated' or leave unspecified for ID
sortDir string Sort direction. Can be 'asc' or 'desc' - defaults to 'asc'
page int Page number
perPage int Number of results per page - defaults to 25

Exceptions

This endpoint doesn't throw any exceptions.

Response

This endpoint doesn't return a response.