Get Shareable

GET 
/shared/:shareable_id

Get Shareable

Request

Path Parameters

shareable_id Shareable IDrequired

Responses

200

Successful Response

application/json

Schema

Schema

record objectrequired
items object[]required
Array [
created_at date-time
The time the item was created
updated_at date-time
owner_id Owner Id
The ID of the user the object belongs to
_id Id
The unique identifier for the object
scanner_account_id Scanner Account Id
The ID of the account that scanned the item
started_at date-timerequired
Time at which user started flow.
ended_at date-timerequired
Time at which user finished entire flow.
flow_id Flow Id
The ID of the flow used during the scanning session
scanner_account Scanner Account
The name of the scanner account that scanned the item
photographing object[]
The list of photographing steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
The time at which the photographing step started
ended_at date-timerequired
The time at which the photographing step ended
photos object[]
The list of photos that were taken during the photographing step
Array [
date date-timerequired
The date and time the photo was taken
url Url
The url of the photo
]
]
dimensioning object[]
The list of dimensioning steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
Time at which user started dimensioning step
ended_at date-timerequired
Time at which user finished dimensioning step
mode object
The mode of dimensioning
anyOf
DimensioningMode
string
MOD2
string
dimensions object
started_at date-timerequired
Time at which user first saw predicted dimensions
ended_at date-timerequired
Time at which user confirmed the final dimensions.
width Widthrequired
The final width of the item
height Heightrequired
The final height of the item
depth Depthrequired
The final depth of the item
unit DimensioningUnit
Possible values: [m, mm, cm, ft, in]
The unit of the dimensions
allowed_rotations object
_id Id
The unique identifier for the object
started_at date-timerequired
Time at which user started filling in allowed rotations
ended_at date-timerequired
Time at which user finished filling in allowed rotations
allow_width_depth_on_floor Allow Width Depth On Floorrequired
Whether the item can be placed down with its width and depth facing the floor
allow_width_height_on_floor Allow Width Height On Floorrequired
Whether the item can be placed down with its width and height facing the floor
allow_depth_height_on_floor Allow Depth Height On Floorrequired
Whether the item can be placed down with its depth and height facing the floor
screenshot object
url Url
The url of the screenshot of the item with the bounding box
date date-time
The date and time the screenshot was taken
bounding_box_manual_edited Bounding Box Manual Edited
Whether the bounding box was manually edited
bounding_box_dims number[]
The final bounding box dimensions
recordings object[]
The list of dimension recordings
Array [
screenshot object
url Url
The url of the screenshot of the item with the bounding box
date date-time
The date and time the screenshot was taken
dims number[]
The dimensions of the bounding box as measured at this specific step in the dimensioning process in meters
is_initial Is Initial
Whether this is the initial recording
is_rejected Is Rejected
Whether this recording was rejected by the user
frames object[]
The list of frames taken during the recording
Array [
rgb object
date date-timerequired
The date and time the photo was taken
url Url
The url of the photo
]
]
]
weighing object[]
The list of weighing steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
The time at which the weighing step started
ended_at date-timerequired
The time at which the weighing step ended
weight Weightrequired
The weight of the item
unit object
An enumeration.
photos object[]
The photos of the weight scale's display
Array [
date date-timerequired
The date and time the photo was taken
url Url
The url of the photo
]
]
barcode_scanning object[]
The list of barcode scanning steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
Time at which user started barcode collection
ended_at date-timerequired
Time at which user finished barcode collection
code Coderequired
The scanned barcode
]
single_choices object[]
The list of single choice steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
The time at which the single choice step started
ended_at date-timerequired
The time at which the single choice step ended
choice Choice
The choice that has to be made
selected Selected
The selected choice
]
multi_choices object[]
The list of multi choice steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
started_at date-timerequired
ended_at date-timerequired
choice Choice
The question
selected string[]
The selected choices
]
custom_inputs object[]
The list of custom input steps
Array [
flow_step_id Flow Step Id
The ID of the flow step
title Titlerequired
The question
started_at date-timerequired
The date and time the custom input module was started
ended_at date-timerequired
The date and time the custom input module was ended
double_val Double Val
The value of the custom input (if it is a number input)
string_val String Val
The value of the custom input (if it is a string input)
]
extraction object[]
The list of extraction steps
Array [
flow_step_id Flow Step Idrequired
The identifier of the flow step
started_at date-timerequired
The date and time the extraction was started
ended_at date-timerequired
The date and time the extraction was completed
photos object[]
The photos that were used for extraction
Array [
date date-timerequired
The date and time the photo was taken
url Url
The url of the photo
]
found object[]
The results of the extraction
Array [
extraction_id Extraction Id
The identifier of the extraction result
values string[]
The values extracted
group_id Group Id
Group ID for the extraction item
]
]
classification object[]
The list of classification steps
Array [
flow_step_id Flow Step Idrequired
The identifier of the flow step
_id Id
The unique identifier for the object
started_at date-timerequired
The date and time the extraction was started
ended_at date-timerequired
The date and time the extraction was completed
photos object[]
The photos that were used for classification
Array [
date date-timerequired
The date and time the photo was taken
url Url
The url of the photo
]
matched_class_ids string[]
The list of matched class IDs from the classification
]
]
view object

owner_id Owner Id

The ID of the user the object belongs to

_id Id

The unique identifier for the object

created_at date-time

The time the view was created

name Namerequired

The name of the view

join_by Join By

The column to join by

fuzzy_queries string[]

Default value: ``

The fuzzy queries

strict_queries string[]

Default value: ``

The strict queries

path_queries string[]

Default value: ``

The path queries

sort_by Sort By

The path to sort by

sort_direction Sort Direction

The direction to sort, 1 for ascending, -1 for descending

included_paths string[]

Default value: ``

The paths to include, if empty, calculate the 'most useful' paths from data

scanner_account_ids string[]

Default value: ``

The scanner account IDs to include data from, if empty, include all

flow_ids string[]

Default value: ``

The flow IDs to include data from, if empty, include all

custom_column_names object

The column names, maps form paths to names

property name* string

not_null_paths string[]

Default value: ``

The paths that must not be null

ranking_number Ranking Number

Default value: 1

Primary sorting key in result return, used to determine the rank of this view in the list of views in UI, lower is earlier. Set by user.

timezone Timezone

The display and export timezone

last_exported_at date-time

The time the view was last exported

logo_base64 Logo Base64

The base64 encoded logo to be shown on exports. Max 50KiB.

hide_timestamps Hide Timestamps

Default value: false

Whether to hide the timestamps in the shared timeline view

photos object[]required
Array [
photo Photo URLrequired
date date-timerequired
path Pathrequired
]

Example (from schema)

{
  "record": {},
  "items": [
    {
      "startedAt": "2025-08-05T22:55:58.215681",
      "endedAt": "2025-08-05T22:56:58.215695",
      "photographing": [],
      "dimensioning": [],
      "weighing": [],
      "barcodeScanning": []
    }
  ],
  "view": {
    "owner_id": "string",
    "_id": "string",
    "created_at": "2025-08-05T23:45:09.467Z",
    "name": "string",
    "join_by": "string",
    "fuzzy_queries": [
      "string"
    ],
    "strict_queries": [
      "string"
    ],
    "path_queries": [
      "string"
    ],
    "sort_by": "string",
    "sort_direction": 0,
    "included_paths": [
      "string"
    ],
    "scanner_account_ids": [
      "string"
    ],
    "flow_ids": [
      "string"
    ],
    "custom_column_names": {},
    "not_null_paths": [
      "string"
    ],
    "ranking_number": 1,
    "timezone": "string",
    "last_exported_at": "2025-08-05T23:45:09.467Z",
    "logo_base64": "string",
    "hide_timestamps": false
  },
  "photos": [
    {
      "photo": "string",
      "date": "2025-08-05T23:45:09.467Z",
      "path": "string"
    }
  ]
}

404

Not found

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
MOD2
string
integer
]
msg Messagerequired
type Error Typerequired
]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...