Skip to content
Menu
Close

Quick Quote

Check rates and availability.

Address or Zip-code of where we’ll be filming
If we are filming a home or building, enter up to 100,000 sq ft
The location entered impacts date availability
The date selected impacts time availability
Developer center

Make your first connection.

A small starting point: retrieve your orders, inspect delivery details, and connect the result to your own application.

1. Confirm access with our team

Contact support@qwikvid.com with your QwikVid account email, the system you are connecting, and the workflow you need. We will confirm the account access and credentials appropriate to that integration.

A key acts as its associated QwikVid user. Use an account approved for the integration and keep the key in your server's secret store or environment. Do not put it in browser JavaScript, mobile app bundles, public repositories or a shared Postman collection.

2. Choose the right environment

The production base URL is https://www.qwikvid.com. Arrange test access and approved sample data with the team before testing. A key labelled “test” does not, by itself, make requests to the production URL use a separate database.

The requests in this quickstart read existing orders. They do not place a booking, change an appointment or charge a payment. Read access can still return customer and property information; keep responses within your authorized application.

3. List your orders

Set QWIKVID_API_KEY in your server environment, then use this Bash/cURL example. The key and action are form fields. These endpoints do not use an Authorization Bearer header.

Bash / cURL
curl --request POST \
  'https://www.qwikvid.com/api/v2/utilities/order/list/?view_range=30days' \
  --data-urlencode "key=$QWIKVID_API_KEY" \
  --data-urlencode 'action=getOrders'

view_range=30days filters by the order's appointment date. It is not an “updated since” cursor. Remove that query parameter if you need all orders visible to the user.

Successful empty list
{
  "error": null,
  "data": []
}

A nonempty data array contains fields including order_no, ticket_id, status, property address and appointment details. Save the ticket_id against your own property record; do not use the street address alone as an identifier.

4. Read one order's delivery details

Set QWIKVID_TICKET_ID to a ticket ID returned by the order list. The numeric order number is a different identifier.

Bash / cURL
curl --request POST \
  'https://www.qwikvid.com/api/v2/utilities/order/detail/' \
  --data-urlencode "key=$QWIKVID_API_KEY" \
  --data-urlencode "ticket_id=$QWIKVID_TICKET_ID" \
  --data-urlencode 'include_photos=false'

A successful detail response is a JSON object at the root, rather than the list endpoint's data array. Check for an error object first, even if the HTTP status is 200.

Before showing a download, check can_download_deliverables, the relevant media field, and package readiness where available. See the field reference for the exact distinction between media existing and being available to this user.

5. Handle errors and agree your sync cadence

Use bounded retries for temporary network/server failures on these read requests. Do not repeatedly retry invalid credentials, missing identifiers or denied access. Agree a polling cadence with our team; these docs do not promise unlimited traffic or a public webhook subscription.

If your workflow needs booking creation, automatic status events, cancellation or rescheduling, discuss those requirements before wiring a write operation into production.

View the reference →Discuss an integration →