API Reference

Request materials for a specific order and assignment

get
https://sync.bkbn.com/v1/orders//assignments//materials

Requests materials (media files, documents, or result URLs) for a given order and assignment. The response includes: - Media files (photos, videos) when applicable for the product type - Result URLs for virtual tours and similar products that don't have downloadable files - Documents for document-based product types. For photo products, the optional visualQuality query parameter selects between full-resolution (HD, default) and web-optimized (WEB) deliverables. Sending visualQuality with a non-photo product returns 400. To avoid photo duplications, make a request to the endpoint using the modifiedSince parameter with the datetime of the previous upload. It will return only the visuals created or updated after that date and time.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the order

string
required

Unique identifier of the assignment within the order

Query Params
string
enum
required

Type of product/service for which materials are requested

string
enum
            Quality of the photo materials. Only applicable to photo products
            (GROUND_PHOTO, GROUND_PHOTO_PRESTIGE, DRONE_PHOTO, RESIDENTIAL_STAGING,
            COMMERCIAL_STAGING, RESIDENTIAL_RENDERING, COMMERCIAL_RENDERING).

            - HD (default when omitted): full-resolution post-processed photo.
            - WEB: web-optimised post-processed photo.

            Sending visualQuality with a non-photo product returns 400.
Allowed:
date-time
            Optional ISO-8601 timestamp. When provided, only materials modified at or after this
            instant are returned. Omitting the parameter preserves the legacy behavior (all
            materials returned).
Responses

Updated 14 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago