---
title: "Get orders with filters"
method: GET
path: "/api/v3.3/orders"
tags: ["Orders"]
---

# Get orders with filters

`GET /api/v3.3/orders`

Retrieves orders with optional filtering by guest UID, property UID, lead UID or update timestamp. At least one filter parameter must be provided

## Query parameters

- `guestUid` string
- `propertyUid` string
- `leadUid` string
- `updatedSince` string

## Response `200`

Successful Operation

- OrdersApiResponseWrapper
  - `orders` OrderApi3Dto[]
    - `uid` string
    - `leadUid` string
    - `creationUtcDateTime` string
    - `updatedUtcDateTime` string
    - `rent` OrderRentApi3Dto
      - `rentNetPrice` number
      - `rentBreakdowns` OrderRentBreakdownApi3Dto[]
        - `nightlyAmount` number
        - `nightlyDate` string, date
      - `extraGuestsNetPrice` number
      - `listPrice` number
      - `discount` DiscountGraphQLApiTO
        - `discountCode` string
        - `discountType` 'AMOUNT' | 'PERCENT'
        - `amount` number
        - `percent` number
      - `netPrice` number
      - `taxationRate` number
      - `taxAmount` number
      - `grossPrice` number
    - `securityDeposit` number — The securit deposit paid, if any, in this reservation. 1. It is not inclusive in case the Additional Charge Option is enabled for the agency 2. It is not inclusive for normal Security Deposit (due at check in) 3. It is inclusive for normal Security Deposit (due at booking time)
    - `fees` OrderFeesApi3Dto
      - `cleaningFee` OrderFeeApi3Dto
        - `uid` string
        - `name` string
        - `amountType` 'AMOUNT' | 'TAX'
        - `isEditable` boolean
        - `netPrice` number
        - `taxationRate` number
        - `taxAmount` number
        - `grossAmount` number
        - `grossPrice` number
      - `otherFees` OrderFeeApi3Dto[]
        - `uid` string
        - `name` string
        - `amountType` 'AMOUNT' | 'TAX'
        - `isEditable` boolean
        - `netPrice` number
        - `taxationRate` number
        - `taxAmount` number
        - `grossAmount` number
        - `grossPrice` number
    - `services` OrderServiceApi3Dto[]
      - `title` string
      - `grossPrice` number
      - `quantity` integer
      - `quantityDescription` string
      - `serviceUid` string
      - `uid` string
    - `adjustments` OrderAdjustmentApi3Dto[]
      - `isPaid` boolean
      - `amount` number
    - `rateMultiplier` number
    - `currency` 'USD' | 'EUR' | 'GBP' | 'CAD' | 'JPY' | 'INR' | 'MYR' | 'AUD' | 'KES' | 'MXN' | 'HKD' | 'NZD' | 'CHF' | 'BRL' | 'CLP' | 'COP' | 'PEN' | 'ARS' | 'UYU' | 'VEF' | 'CNY' | 'THB' | 'KRW' | 'IDR' | 'SGD' | 'TWD' | 'AED' | 'ZAR' | 'CZK' | 'DKK' | 'DOP' | 'SEK' | 'BGN' | 'ILS' | 'NOK' | 'RON' | 'RUB' | 'PHP' | 'VND' | 'HUF' | 'IKR' | 'PLN' | 'PYG' | 'TRY' | 'GTQ' | 'VUV' | 'JOD' | 'SAR' | 'EGP' | 'TTD' | 'MAD' | 'CVE' | 'BBD' | 'AWG' | 'BHD' | 'NONE'
    - `totalAmount` number
    - `totalTaxesAmount` number
    - `channelCommission` OrderChannelCommissionApi3Dto
      - `amount` number
    - `adjustmentItems` OrderAdjustmentItemApi3Dto[]
      - `uid` string
      - `transactionType` 'CHARGE' | 'REFUND'
      - `adjustmentType` 'RENT' | 'TAX' | 'FEE' | 'SERVICE' | 'RESOLUTION'
      - `amount` number
      - `note` string
      - `createdUtcDateTime` string
      - `externalId` string
    - `externalOrderId` string
  - `_metadata` Api3ResponseMetadata
    - `count` integer
    - `totalCount` integer

---

[API](https://skmtc.dev/hostfully/apis/hostfully-api.md) · [All operations](https://skmtc.dev/hostfully/apis/hostfully-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hostfully/hostfully-api/revisions/8387ad22afc6/schema)