Appearance
package
Represents a package sent to a contact, containing a curated selection of models. Packages may be of type gallery (models presented with their media) or casting (models presented from a specific gallery).
ACCESS
Directly accessible in:
Model PackageExample
json
{
"id": 1,
"token": "cg3fonp7ea90gr6dh2o0",
"import_id": null,
"user_id": 1,
"description": "Syngency Summer Lookbook",
"type": "gallery",
"views": 1,
"contact_id": 1,
"office_id": null,
"agency_id": 1,
"sent_at": "2025-01-31 12:00:00",
"viewed_at": "2025-01-31 12:00:00",
"expires_at": "2025-01-31 12:00:00",
"created_at": "2025-01-31 12:00:00",
"updated_at": "2025-01-31 12:00:00",
"deleted_at": "2025-01-31 12:00:00",
"contact_name": null,
"user_name": null,
"user_email": null,
"is_expired": null,
"pdf_url": "https://pdf.syngency.com/package/[packageToken]",
"preview_url": "https://agency.com/packages/[packageToken]",
"notification_tag": null,
"groups": [{
"id": 1,
"name": "Group Name",
"notes": "<p>Group note</p>",
"package_id": 1,
"models": []
}],
"models": [{
"id": 1,
"package_id": 1,
"package_group_id": null,
"model_division_id": 1,
"model_gallery_id": null,
"model_gallery_file_id": null,
"sort_order": 1,
"notes": null,
"views": 1,
"created_at": "2025-01-31 12:00:00",
"updated_at": "2025-01-31 12:00:00",
"package_token": null,
"model_id": 1,
"model_token": null,
"display_name": null,
"first_name": null,
"last_name": null,
"date_of_birth": null,
"current_status": null,
"current_location": null,
"profile": null,
"gender": null,
"website": null,
"email": null,
"age": null,
"hair_color": null,
"eye_color": null,
"handle": "Sarah-jones",
"model_gallery_name": null,
"model_division_type_id": 1,
"model_division_type_name": "Fashion",
"office_id": 1,
"url": null,
"resume_url": null,
"headshot_url": null,
"social": null,
"ethnicities": [{
"id": 1,
"name": "White / Caucasian"
}],
"groups": [{
"id": 1,
"name": "Non Union"
}],
"measurements": [],
"images": [{
"id": 1,
"package_model_id": 1,
"model_gallery_file_id": 1,
"casting_model_file_id": null,
"sort_order": 1,
"external_id": null,
"ext": "jpg",
"external_source": "vimeo",
"model_gallery_id": 1,
"model_gallery_name": null,
"media_type": "image",
"width": null,
"height": null,
"credit": null,
"is_landscape": 0,
"is_image": 0,
"is_video": 0,
"is_audio": 0,
"created_at": "2025-01-31 12:00:00",
"updated_at": "2025-01-31 12:00:00",
"url": null,
"small_url": null,
"medium_url": null,
"large_url": null
}]
}],
"package_contact": null
}Properties
id
integertoken
stringimport_id
integeruser_id
integerdescription
stringtype
stringPackage type — gallery or casting.
views
integercontact_id
integeroffice_id
integeragency_id
integersent_at
datetimeviewed_at
datetimeexpires_at
datetimecreated_at
datetimeupdated_at
datetimedeleted_at
datetimecontact_name
stringuser_name
stringuser_email
stringis_expired
booleanpdf_url
stringFormat: absolute-url
preview_url
stringFormat: absolute-url
notification_tag
stringFormat: html
An invisible tracking pixel <img> tag for email open tracking. Only present in casting and gallery package email templates.
groups
arrayid
integername
stringnotes
stringFormat: html
package_id
integermodels
arrayModels assigned to this group. Same structure as top-level package.models.
Item properties not defined.
models
arrayid
integerpackage_id
integerpackage_group_id
integermodel_division_id
integermodel_gallery_id
integerPopulated in casting packages — references the specific gallery being presented.
model_gallery_file_id
integersort_order
integernotes
stringviews
integercreated_at
datetimeupdated_at
datetimepackage_token
stringmodel_id
integermodel_token
stringdisplay_name
stringfirst_name
stringlast_name
stringdate_of_birth
datecurrent_status
stringcurrent_location
stringprofile
stringFormat: html
Bio/profile text.
gender
stringwebsite
stringemail
stringage
integerhair_color
stringeye_color
stringhandle
stringmodel_gallery_name
stringName of the gallery being presented. Populated in casting packages.
model_division_type_id
integermodel_division_type_name
stringoffice_id
integerurl
stringFormat: absolute-url
Portfolio URL including package_token as a querystring parameter.
resume_url
stringFormat: absolute-url
headshot_url
stringFormat: absolute-url
social
objectKeyed by service name. Same structure as model.social. See the common model object for full property reference.
ethnicities
arrayid
integername
stringgroups
arrayid
integername
stringmeasurements
arrayArray of measurement objects.
images
arrayAvailable in gallery packages only. Contains images, video, and audio media items.
id
integerpackage_model_id
integermodel_gallery_file_id
integercasting_model_file_id
integersort_order
integerexternal_id
stringext
stringexternal_source
stringmodel_gallery_id
integermodel_gallery_name
stringmedia_type
stringOne of image, video, or audio.
width
integerheight
integercredit
stringis_landscape
booleanis_image
booleanis_video
booleanis_audio
booleancreated_at
datetimeupdated_at
datetimeurl
stringFormat: absolute-url
small_url
stringFormat: absolute-url
Available for images and video thumbnails. Not present for audio.
medium_url
stringFormat: absolute-url
Available for images and video thumbnails. Not present for audio.
large_url
stringFormat: absolute-url
Available for images and video thumbnails. Not present for audio.
package_contact
stringContact details rendered at the bottom of the PDF package.