This endpoint is currently in BETA.
Experiment with this API

Boards - Get Comments

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 comments for a specific board.

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 comments for a board:

GET https://api.gettyimages.com/v3/boards/{board_id}/comments

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}/comments

Your response will look similar to:

{
  "comments": [
    {
      "created_by": {
        "first_name": "",
        "last_name": ""
      },
      "date_created": "",
      "id": "",
      "permissions": {
        "delete_comment": false
      },
      "text": "Some comment"
    }
  ]
}

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 Specify the board to retrieve comments from. Required.

Response Body Fields

comment_list

comments array [ comment ] Lists comments on the board.
permissions Specifies the allowed actions for the collaborator at the comment list level.

comment

created_by Specifies the collaborator who created the comment.
date_created string Specifies the date that the comment was created.
id string Specifies a unique identifier for the comment.
permissions Specifies the allowed actions for the collaborator for a comment.
text string Specifies the text of the comment.

collaborator

first_name string Specifies the first name of a collaborator.
last_name string Specifies the last name of a collaborator.

comment_permissions

can_delete_comment boolean Specifies whether the collaborator is allowed to delete the comment.

board_comment_permissions

can_add_comment boolean Specifies whether the collaborator is allowed to add a comment to the comments list.

Response Status Codes

200 OK
400 InvalidParameterValue
401 Unauthorized
403 SecureTokenRequired
404 BoardNotFound