HighLevel: Snapshots schemas

← Snapshots operations · All schemas

Create Snapshot Share Link — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
relationship_number	string	Optional	Comma separated Relationship number of Agencies to create agency restricted share link
share_location_id	string	Optional	Comma separated Sub-Account ids to create sub-account restricted share link
share_type	string	Required within parent	Type of share link to generate One of: link, permanent_link, agency_link, location_link
snapshot_id	string	Required within parent	id for snapshot to be shared

Create Snapshot Share Link — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	id for shared snapshot
shareLink	string	Optional	Share Link for snapshot

Get Last Snapshot Push — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	Model	Optional	Expand Get Last Snapshot Push — response body — data

Referenced models: Get Last Snapshot Push — response body — data

Get Last Snapshot Push — response body — data

Field	Type	Presence	Description and constraints
$	object	Root
completed	array	Optional	List of completed assets
completed[]	string	Each item
id	string	Optional	Document id
locationId	string	Optional	Sub-account id
pending	array	Optional	List of pending assets
pending[]	string	Each item
status	string	Optional	Status of snapshot push

Get Snapshot Push between Dates — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Optional
data[]	Model	Each item	Expand Get Snapshot Push between Dates — response body — data item

Referenced models: Get Snapshot Push between Dates — response body — data item

Get Snapshot Push between Dates — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
dateAdded	string	Optional	Timestamp of when snapshot processing starts for sub-account Format: date-time
id	string	Optional	Document id
locationId	string	Optional	Sub-account id
status	string	Optional	Status of snapshot push

Get Snapshots — response body

Field	Type	Presence	Description and constraints
$	object	Root
snapshots	array	Optional
snapshots[]	Model	Each item	Expand Get Snapshots — response body — snapshots item

Referenced models: Get Snapshots — response body — snapshots item

Get Snapshots — response body — snapshots item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	Snapshot Id.
name	string	Optional	Name of the snapshot
type	string	Optional	Type of snapshot - own or imported.