Skip to content

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:

Package

Example

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 integer
token string
import_id integer
user_id integer
description string
type string

Package type — gallery or casting.

views integer
contact_id integer
office_id integer
agency_id integer
sent_at datetime
viewed_at datetime
expires_at datetime
created_at datetime
updated_at datetime
deleted_at datetime
contact_name string
user_name string
user_email string
is_expired boolean
pdf_url string

Format: absolute-url

preview_url string

Format: absolute-url

notification_tag string

Format: html

An invisible tracking pixel <img> tag for email open tracking. Only present in casting and gallery package email templates.

groups array
id integer
name string
notes string

Format: html

package_id integer
models array

Models assigned to this group. Same structure as top-level package.models.

Item properties not defined.

models array
id integer
package_id integer
package_group_id integer
model_division_id integer
model_gallery_id integer

Populated in casting packages — references the specific gallery being presented.

model_gallery_file_id integer
sort_order integer
notes string
views integer
created_at datetime
updated_at datetime
package_token string
model_id integer
model_token string
display_name string
first_name string
last_name string
date_of_birth date
current_status string
current_location string
profile string

Format: html

Bio/profile text.

gender string
website string
email string
age integer
hair_color string
eye_color string
handle string
model_gallery_name string

Name of the gallery being presented. Populated in casting packages.

model_division_type_id integer
model_division_type_name string
office_id integer
url string

Format: absolute-url

Portfolio URL including package_token as a querystring parameter.

resume_url string

Format: absolute-url

headshot_url string

Format: absolute-url

social object

Keyed by service name. Same structure as model.social. See the common model object for full property reference.

ethnicities array
id integer
name string
groups array
id integer
name string
measurements array

Array of measurement objects.

images array

Available in gallery packages only. Contains images, video, and audio media items.

id integer
package_model_id integer
model_gallery_file_id integer
casting_model_file_id integer
sort_order integer
external_id string
ext string
external_source string
model_gallery_id integer
model_gallery_name string
media_type string

One of image, video, or audio.

width integer
height integer
credit string
is_landscape boolean
is_image boolean
is_video boolean
is_audio boolean
created_at datetime
updated_at datetime
url string

Format: absolute-url

small_url string

Format: absolute-url

Available for images and video thumbnails. Not present for audio.

medium_url string

Format: absolute-url

Available for images and video thumbnails. Not present for audio.

large_url string

Format: absolute-url

Available for images and video thumbnails. Not present for audio.

package_contact string

Contact details rendered at the bottom of the PDF package.