API Reference

Request materials for a specific order and assignment

get deprecated
https://sync.bkbn.com/materials//

Deprecated: use GET /v1/orders/{orderId}/assignments/{assignmentId}/materials instead. Sunset: 2026-09-10. 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

        The visualType parameter is optional and defaults to POST. For document products,
        it should be set to DOCUMENT or omitted.
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
            Optional type of visual/resource to request. Defaults to POST if not specified.

            - POST: Standard post-processed visuals (HD).
            - POST_WEB: Web-optimised post-processed visuals.
            - DOCUMENT: Document files (for document products). Equivalent to omitting visualType.
            - RAW: No longer supported; returns 400. Migrate to GET /v1/orders/{orderId}/assignments/{assignmentId}/materials.
Allowed:
Responses

Updated 1 day 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 1 day ago