List available photos

GET

/cms/photo

• The API server for the WhiteBeard News Suite
• Local development server for the WhiteBeard News Suite
• Local worker for the WhiteBeard News Suite

Returns a list of available photos.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

limit

integer

>= 1 <= 200

page

integer

>= 1

anything

string

Search term that matches any field

name

string

description

string

photographer

string

location

string

people

string

source

string

keywords

string

date_from

string format: date

date_to

string format: date

user

integer

User ID of the uploader

parent

integer

Parent content ID

ids

Comma-separated attachment ids

string

lowres

string

If set, only return low-resolution photos

show_dupes

string

If set, include duplicate or re-used photos in the results

Responses

200

Photo results

object

page

integer

total

integer

data

Array<object>

Attachment

API representation of an attachment (images, video, files)

object

id

Attachment ID

integer format: int64

name

Name

string

nullable

description

Description

string

nullable

type

Type (image|video|file)

string

url

Public URL

string

nullable

width

Width in pixels

integer format: int32

height

Height in pixels

integer format: int32

focal

Focal point as “x% y%”

string

nullable

transforms

Transforms (list of available image transforms)

Array<object>

object

x

Width in pixels

integer format: int32

y

Height in pixels

integer format: int32

url

URL of the transformed image

string

urls

Additional urls per transform

object

url_medium

Search title

string

url_highres

Search description

string

url_original

Social title

string

video

One of:

Video

Video

API representation of a video

object

id

Video ID

integer format: int64

title

Title

string

url

URL

string

duration

Duration in seconds

integer format: int64

number

Episode number

integer format: int64

nullable

status

Status

string

showId

Show ID

integer format: int64

nullable

showName

Show name

string

nullable

showUrl

Show URL

string

nullable

brief

Brief

string

nullable

thumbnail

Thumbnail URL

string

nullable

thumbnailPlay

ThumbnailPlay URL

string

nullable

filename

Filename/URL

string

nullable

publishDate

Publish date

string

nullable

views

Views

integer format: int64

publish

Publish flag

nullable

formats

Formats

Array<object>

nullable

Video_Format

API representation of a video format

object

format

Format

string

filename

Filename/URL

string

cdnPath

CDN path

string

nullable

mime

MIME type

string

duration

Duration in seconds

integer format: int32

nullable