SNsnappr
Magic Jobs

Get a Magic Job

Retrieves one Magic Job. A job moves through created, in_progress, completed and failed. It stays in_progress while further deliveries are expected and becomes completed once all images are delivered, at which point completed_at and images_count are populated. Failed jobs are followed up by your account manager.

get/magic-jobs/{magic_job_uid}

Request

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

Path parameters

magic_job_uidstring uuid required

The Magic Job's uid.

Headers

accept-versionstring

API version. The only version is 1.0.0.

Response

The Magic Job.

uidstring uuid required
type'menu' required
status'created' | 'in_progress' | 'completed' | 'failed' required
completed_atstring date-time nullable
restaurant_namestring nullable
restaurant_addressstring nullable
source_platformstring nullable

Platform Snappr found the listing on.

source_urlstring uri nullable
internal_idstring nullable
images_countinteger

Number of delivered images. Present only when status is completed.

created_atstring date-time
updated_atstring date-time

Changes

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