Get photo details

GET

/cms/photo/{id}

curl --request GET \
  --url https://api.example.com/cms/photo/1 \
  --header 'API-Key: <API-Key>'

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

Returns details of a specific photo.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

integer

Responses

200

Photo details

Media typeapplication/json

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

Example ^generated

{
  "id": 1,
  "name": "example",
  "description": "example",
  "type": "example",
  "url": "example",
  "width": 1,
  "height": 1,
  "focal": "example",
  "transforms": [
    {
      "x": 1,
      "y": 1,
      "url": "example"
    }
  ],
  "urls": {
    "url_medium": "example",
    "url_highres": "example",
    "url_original": "example"
  },
  "video": {
    "id": 1,
    "title": "example",
    "url": "example",
    "duration": 1,
    "number": 1,
    "status": "example",
    "showId": 1,
    "showName": "example",
    "showUrl": "example",
    "brief": "example",
    "thumbnail": "example",
    "thumbnailPlay": "example",
    "filename": "example",
    "publishDate": "example",
    "views": 1,
    "publish": "example",
    "formats": [
      {
        "format": "example",
        "filename": "example",
        "cdnPath": "example",
        "mime": "example"
      }
    ]
  },
  "duration": 1
}

403

Forbidden

404

Photo not found