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
| Name | Type | Description |
|---|---|---|
page
|
int | The page number for the results being shown |
perPage
|
int | The number of results that will be on each page |
totalResults
|
int | The total number of results |
totalPages
|
int | The number of pages of results |
results
|
array of image objects | The results for this page |
image object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
caption
|
string | Caption |
description
|
string | Description |
filename
|
string | Original file name (e.g. 'image.png') |
filesize
|
int | Original file size, in bytes |
images
|
object | URLs to where the images are stored. Keys are 'original', 'large', and 'small', and values are URLs to the corresponding images |
album
|
album object | The album, if in one |
category
|
category object | The category (if in an album, this will be the category that the album is in) |
author
|
member object | The author |
copyright
|
string | Copyright |
credit
|
string | Credit |
location
|
geolocation object | The location where the picture was taken, if it was able to be retreived from the EXIF data |
exif
|
object | The raw EXIF data |
date
|
datetime | Date image was uploaded |
comments
|
int | Number of comments |
reviews
|
int | Number of reviews |
views
|
int | Number of views |
prefix
|
string | The prefix tag, if there is one |
tags
|
array of strings | The tags |
locked
|
bool | Image is locked |
hidden
|
bool | Image is hidden |
featured
|
bool | Image is featured |
pinned
|
bool | Image is pinned |
url
|
string | URL |
rating
|
float | Average Rating |
nsfw
|
bool | Not safe for work |
album object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Name |
description
|
string | Description |
category
|
category object | The category |
owner
|
member object | The owner |
privacy
|
string | 'public', 'private' (can only be viewed by owner) or 'restricted' (can only be viewed by owner or approved members) |
approvedMembers
|
array of member objects | If the album is restricted, the members who can view it, in addition to the owner and moderators with appropriate permission |
images
|
int | Number of images |
url
|
string | URL |
category object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Name |
url
|
string | URL |
class
|
string | Node class |
parentId
|
int|null | Parent Node ID |
permissions
|
object|null | Node permissions |
member object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Username |
title
|
string | Member title |
timezone
|
string | Member timezone |
formattedName
|
string | Username with group formatting |
primaryGroup
|
group object | Primary group |
secondaryGroups
|
array of group objects | Secondary groups |
email
|
string | Email address |
joined
|
datetime | Registration date |
registrationIpAddress
|
string | IP address when registered |
warningPoints
|
int | Number of active warning points |
reputationPoints
|
int | Number of reputation points |
photoUrl
|
string | URL to photo (which will be the site's default if they haven't set one) |
photoUrlIsDefault
|
bool | Indicates if the value of photoUrl is the site's default |
coverPhotoUrl
|
string | URL to profile cover photo (will be blank if there isn't one) |
profileUrl
|
string|null | URL to profile |
validating
|
bool | Whether or not the validating flag is set on the member account |
posts
|
int | Number of content item submissions member has made |
lastActivity
|
datetime|null | Last activity date on the site. |
lastVisit
|
datetime|null | Last distinct visit date on the site. |
lastPost
|
datetime|null | Latest content submission date. |
profileViews
|
int | Number of times member's profile has been viewed |
birthday
|
string | Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied). |
customFields
|
array of fieldgroup objects | Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included |
rank
|
array of rank objects | Rank |
achievements_points
|
int | Points |
allowAdminEmails
|
bool | Whether or not this member wants to receive admin emails |
completed
|
bool | Whether or not the registration is completed |
group object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Name |
formattedName
|
string | Name with formatting |