Images

List a Magic Job's images

Lists the current complete set of delivered images for a Magic Job, across all delivery batches. Each result is one image for one menu item. If Snappr replaces an image after delivery it keeps its uid (the stable handle for diffing) while internal_ids and URLs may change. URLs are signed and expire at url_expires_at; call again for freshly signed URLs.

get/magic-jobs/{magic_job_uid}/images

Request

  • Base URL
    https://api.snappr.com
  • URL
    https://api.snappr.com/magic-jobs/{magic_job_uid}/images
  • Auth
    HTTP bearer

Path parameters

magic_job_uidstring uuid required

The Magic Job's uid.

Query parameters

limitinteger

Maximum number of items to return.

offsetinteger

Number of items to skip, for pagination.

Headers

accept-versionstring

API version. The only version is 1.0.0.

Response

A page of images.

countinteger required

Number of items in this page.

limitinteger required
offsetinteger required
totalinteger required

Number of items across all pages.

Example response

{
  "results": [
    {
      "content_type": "image/jpeg"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.