This endpoint is currently in BETA.
Experiment with this API

Boards - Get Board

Boards are where you collect, curate, collaborate on and manage photo and video assets in one place. More information on the Boards FAQ. Use this endpoint to retrieve a Board by a specific id.

Quickstart

You'll need an API key and a Resource Owner Grant access token to use this resource. Please see our Getting Started page for more information on how to sign up for an API key.

Use the following endpoint to retrieve details for a specific board:

GET https://api.gettyimages.com/v3/boards/<board id>

Add API key and the Resource Owner Grant token to the request header:

Api-Key: <your api key>
Authorization: Bearer <your secure access token>

Your request would look like this using curl:

curl -X GET -H "Api-Key: <your api key>" -H "Authorization: Bearer <secure access token>" https://api.gettyimages.com/v3/boards/<board id>

Your response will look similar to:

{  
    "id":"<board id>",
    "date_created":"2015-03-06T22:59:25.52Z",
    "description":"Experiment in crowd-sourcing an image board...",
    "hero_asset":{  
        "id":"551984113",
        "date_added":"2015-08-24T16:31:18.4274193Z",
        "display_sizes":[  
            {  
                "name":"thumb",
                "uri":"<resource uri>"
            },
            {  
                "name":"comp",
                "uri":"<resource uri>"
            }
        ],
        "asset_type":"image"
    },
    "date_last_updated":"2015-08-24T16:31:18.427Z",
    "name":"Weird or Funny Stock Photos",
    "asset_count":99
}

Request Headers

Api-Key string Provide your API key. Required.
Authorization string Provide access token in the format of 'Bearer {token}'. Required.
Accept-Language string Provide a header to specify the language of result values.

URI Path Parameters

board_id string Retrieve details for a specific board. Required.

Response Body Fields

board_detail

id string Specifies a unique identifier for the board.
asset_count integer Specifies the total count of assets associated with the board.
assets array [ asset ] Lists the assets associated with the board.
date_created string Specifies the date that the board was created.
date_last_updated string Specifies the date that the board was last updated.
description string Specifies the description of the board.
name string Specifies the name of the board.
comment_count integer Specifies the total count of comments on the board.
permissions Specifies the allowed actions for the collaborator at the board level.
links Specifies URIs that can be used to share or invite other collaborators to a board.

asset

id string Specifies a unique identifier for the asset.
asset_type string Indicates the asset type. Possible values are: image, video.
date_added string Specifies the date that the asset was added to the board.
display_sizes array [ display_size ] Lists the display sizes available for the asset.

display_size

name string Specifies the name of the display size.
uri string GET this URI to retrieve the display size image.

board_permissions

can_delete_board boolean Specifies whether the collaborator is allowed to delete the board.
can_invite_to_board boolean Specifies whether the collaborator is allowed to invite a user to the board.
can_update_name boolean Specifies whether the collaborator is allowed to update the board name.
can_update_description boolean Specifies whether the collaborator is allowed to update the board description.
can_add_assets boolean Specifies whether the collaborator is allowed to add assets to the board.
can_remove_assets boolean Specifies whether the collaborator is allowed to remove assets from the board.

links

invitation string GET this URI to accept an invitation to a board.
share string GET this URI to share a read-only board.

Response Status Codes

200 OK
400 InvalidParameterValue
401 Unauthorized
403 SecureTokenRequired
404 BoardNotFound

Some response items contain hyperlinks which you can use to take you directly to the next steps in your workflow, when appropriate. The following URIs are provided in the response for this request.

display_size.uri string GET this URI to retrieve the display size image.