Many resources have images attached to them. By default we will only include the URL to the original, unaltered image that was uploaded into our system. You can also dynamically resize, alter, and transform images by specifying additional request parameters.

This is achieved by specifying an images request parameter on either GET endpoint type (list collection, get individual resource).

Parameter	Type	Description
images[{resource_name}]	object	Which resource to target. This allows you to target relationships of an object as well.
images[{resource_name}][{field_name}]	array	Provide an array of transformations. A URL to the image will be returned for each.

Example: thumbnail images for event categories

{
  "images": {
    "category": {
      "image": [
        {
          "key": "my_thumbnail",
          "options": {
            "resize": "250x250>"
          }
        }
      ]
    }
  }
}

Transformation options

Parameter	Type	Description
resize	string	Resize the image. For complete reference, refer to the ImageMagick reference.
auto_orient	boolean	Attempts to auto-orient the image. For example, iOS selfies can typically benefit from this option.

We also support any options that ImageMagick supports. For a complete list of options, please see ImageMagick’s command line reference.