Get Smart Collection

Method for getting smart collections. Smart collections are special types of collections created automatically in Whisk. Content in smart collections also updates automatically based on user actions.

This endpoint allows getting smart collection information.

Get Smart Collection

GET https://api.whisk.com/v2/smart_collection/{collection_id}

Getting smart collection by id. Id's for smart collections could be get from Get Collection method in smartCollections array. The type in response represents smart collection type.

SMART_COLLECTION_TYPE_INVALID

SMART_COLLECTION_TYPE_MADE_IT

SMART_COLLECTION_TYPE_RECENTLY_VIEWED

Path Parameters

Name	Type	Description
collection_id	string	Unique collection identifier

Headers

Name	Type	Description
Authorization	String	User Access token to authorize the API usage. For more information, see Authentication

200 Successful response

{
  "collection": {
    "id": "string",
    "name": "string",
    "type": "SMART_COLLECTION_TYPE_INVALID",
    "images": [
      {
        "url": "string",
        "width": 0,
        "height": 0,
        "selection": {
          "x": 0,
          "y": 0,
          "width": 0,
          "height": 0
        }
      }
    ],
    "recipe_count": 0
  },
  "smart_tags": [
    {
      "value": {
        "name": "string",
        "display_name": "string"
      }
    }
  ]
}

401: Unauthorized This failed response appears due to API authentication failure. The possible error codes that may appear are: auth.tokenNotFound, auth.tokenExpired, auth.tokenInvalid, auth.tokenRequired.

{
  "code": "auth.tokenNotFound"
}

500: Internal Server Error This failed response appears when something is not right on Whisk's end. Please send a message to [email protected], and be sure to include both the Request and Response data. We’ll get back to you soon.

This is unexpected response, something is wrong on our side, please contact: [email protected]

Sample Request

Request

Response