Integrate API
Home
Company
Company
  • Company
  • Users
  • Office
Orders
Orders
  • Orders
  • Change Request
  • Drafts
  • GoToScan
Webhooks
Home
Company
Company
  • Company
  • Users
  • Office
Orders
Orders
  • Orders
  • Change Request
  • Drafts
  • GoToScan
Webhooks
  1. Orders
  • Default module
    • Get started
    • Pagination and Offset
    • Company
      • Get company information
      • Delete company webhook
      • Get company package
      • Send a merge request to another company
    • Office
      • List all offices
      • Add new office
    • Users
      • List all users
      • Add new user
      • Get user by email
      • Update user details
      • Change user password
      • Send password reset link
      • Delete user
    • Orders
      • List orders
        GET
      • Upgrade order
        POST
      • Re-deliver order with styling options
        POST
      • Get order by ID
        GET
      • Get combined PDF document
        GET
      • Create a redraw order
        POST
    • Change Request
      • Add new change request for an order
      • List all change requests of order
      • Get change request by ID
    • Draft Orders
      • Create a draft order
      • Update a draft order
      • Delete a draft order
    • GoToScan Orders
      • Create a GoToScan order
    • Webhooks
      • About webhooks
      • Update company webhooks
      • /Order status
  • Webhooks calls
    • /Order status
  1. Orders

List orders

Prod Env
https://app.cubi.casa/api/integrate/v3
Prod Env
https://app.cubi.casa/api/integrate/v3
GET
/orders
List last 20 orders. Paginate results by using the optional limit, offset parameter. You can use the pagination.next_offset value from the response to request the next 20 orders.
status can take multiple values by defining the paramater multiple times, e.g. /orders?status=Pending&status=Ready

Request

Authorization
or
API Key
Add parameter in header
api-key
Example:
api-key: ********************
or
Query Params

Responses

🟢200OK
application/json
List of orders
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://app.cubi.casa/api/integrate/v3/orders?created_before&created_after&user_id&user_email&office&office_id&status&limit&offset'
Response Response Example
{
    "pagination": {
        "has_more": false,
        "limit": 20,
        "next_offset": 21,
        "previous_offset": 0
    },
    "items": [
        {
            "id": "312babc6-e742-4d54-ac49-e0f7b16ec15a",
            "info": {
                "status": "Ready",
                "created_by": "manager@cubicasa.com",
                "location": "121 North Washington Avenue Cubi suite Minneapolis",
                "order_type": "vbim",
                "first_delivered_at": null,
                "created_at": 1716238626.904049,
                "is_scan_order": true,
                "total_scanned_area": 0,
                "go2scan": null,
                "external_id": "EXT10005",
                "add_info": "",
                "style_template": {
                    "id": "a51c5a27-b4b4-4e35-8084-a06b894e5248",
                    "name": "Earth tones",
                    "preview_colors": [
                        "#f4ede7",
                        "#eccaaf",
                        "#777777",
                        "#000000"
                    ]
                },
                "product": {
                    "add_ons": [
                        "gla"
                    ],
                    "over_limits": [],
                    "package_type": "plus",
                    "purchasable_add_ons": null,
                    "purchasable_package_types": null
                },
                "model_id": null
            },
            "address": {
                "city": "Minneapolis",
                "country": "United States",
                "full_address": "121 North Washington Avenue, Minneapolis, Minnesota 55411, United States",
                "latitude": 44.986947,
                "longitude": -93.275918,
                "number": "",
                "postalCode": "55411",
                "state": "Minnesota",
                "street": "121 North Washington Avenue",
                "suite": "Cubi suite"
            }
        },
        {
            "id": "312babc6-e742-4d54-ac49-e0f7b16ec15a",
            "info": {
                "status": "Ready",
                "created_by": "manager@cubicasa.com",
                "location": "121 North Washington Avenue Cubi suite Minneapolis",
                "order_type": "vbim",
                "first_delivered_at": null,
                "created_at": 1716238626.904049,
                "is_scan_order": true,
                "total_scanned_area": 0,
                "go2scan": null,
                "external_id": "EXT10005",
                "add_info": "",
                "style_template": null,
                "product": {
                    "add_ons": [
                        "gla"
                    ],
                    "over_limits": [],
                    "package_type": "plus",
                    "purchasable_add_ons": null,
                    "purchasable_package_types": null
                },
                "model_id": null
            },
            "address": {
                "city": "Minneapolis",
                "country": "United States",
                "full_address": "121 North Washington Avenue, Minneapolis, Minnesota 55411, United States",
                "latitude": 44.986947,
                "longitude": -93.275918,
                "number": "",
                "postalCode": "55411",
                "state": "Minnesota",
                "street": "121 North Washington Avenue",
                "suite": "Cubi suite"
            }
        },
        {
            "id": "312babc6-e742-4d54-ac49-e0f7b16ec15a",
            "info": {
                "status": "Ready",
                "created_by": "manager@cubicasa.com",
                "location": "121 North Washington Avenue Cubi suite Minneapolis",
                "order_type": "vbim",
                "first_delivered_at": null,
                "created_at": 1716238626.904049,
                "is_scan_order": true,
                "total_scanned_area": 0,
                "go2scan": null,
                "external_id": "EXT10005",
                "add_info": "",
                "style_template": {
                    "id": "a51c5a27-b4b4-4e35-8084-a06b894e5248",
                    "name": "Earth tones",
                    "preview_colors": [
                        "#f4ede7",
                        "#eccaaf",
                        "#777777",
                        "#000000"
                    ]
                },
                "product": {
                    "add_ons": [
                        "gla"
                    ],
                    "over_limits": [],
                    "package_type": "plus",
                    "purchasable_add_ons": null,
                    "purchasable_package_types": null
                },
                "model_id": null
            },
            "address": {
                "city": "Minneapolis",
                "country": "United States",
                "full_address": "121 North Washington Avenue, Minneapolis, Minnesota 55411, United States",
                "latitude": 44.986947,
                "longitude": -93.275918,
                "number": "",
                "postalCode": "55411",
                "state": "Minnesota",
                "street": "121 North Washington Avenue",
                "suite": "Cubi suite"
            }
        },
        {
            "id": "312babc6-e742-4d54-ac49-e0f7b16ec15a",
            "info": {
                "status": "Ready",
                "created_by": "manager@cubicasa.com",
                "location": "121 North Washington Avenue Cubi suite Minneapolis",
                "order_type": "vbim",
                "first_delivered_at": null,
                "created_at": 1716238626.904049,
                "is_scan_order": true,
                "total_scanned_area": 0,
                "go2scan": null,
                "external_id": "EXT10005",
                "add_info": "",
                "style_template": null,
                "product": {
                    "add_ons": [
                        "gla"
                    ],
                    "over_limits": [],
                    "package_type": "plus",
                    "purchasable_add_ons": null,
                    "purchasable_package_types": null
                },
                "model_id": null
            },
            "address": {
                "city": "Minneapolis",
                "country": "United States",
                "full_address": "121 North Washington Avenue, Minneapolis, Minnesota 55411, United States",
                "latitude": 44.986947,
                "longitude": -93.275918,
                "number": "",
                "postalCode": "55411",
                "state": "Minnesota",
                "street": "121 North Washington Avenue",
                "suite": "Cubi suite"
            }
        }
    ]
}
Modified at 2025-10-27 22:06:52
Previous
Delete user
Next
Upgrade order
Built with