This endpoint is currently in BETA.
Experiment with this API

Boards - Get All Boards

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 all Boards available for a user.

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 list available boards:

GET https://api.gettyimages.com/v3/boards

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

Your response will look similar to:

{  
    "boards":[  
        {  
            "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.

Querystring Parameters

board_relationship string Search for boards the user owns or has been invited to as an editor. Possible values: owned invited

Sorting and Pagination

page integer Request results starting at a page number (default is 1).
page_size integer Request number of boards to return in each page. (default is 30).

Response Body Fields

board_list

boards array [ board ] Lists boards that the collaborator participates in
board_count integer Specifies the total count of boards that the collaborator participates in

board

id string Specifies a unique identifier for the board.
asset_count integer Specifies the total count of 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.
hero_asset Specifies the asset on a board that is used to represent the overall board.
name string Specifies the name of the board.
board_relationship string Indicates whether the user owns the board or has been invited to it as an editor. Possible values are: owned, invited.

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.

Response Status Codes

200 OK
400 InvalidParameterValue
400 InvalidPageNumber
400 InvalidPageSize
401 Unauthorized
403 SecureTokenRequired

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.