DOdomain
Enquiries

Searches enquiries based on agents or agencies.

Changed on
get/v1/enquiries

Request

  • Base URL
    https://api.domain.com.au
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://auth.domain.com.au/v1/connect/authorize
      Client credentials
      Token URLhttps://auth.domain.com.au/v1/connect/token
      Scopesapi_enquiries_read, api_enquiries_write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

agencyIdinteger

Agency identifier

agentIdinteger

Agent identifier

fromstring date-time

Enquiries received from

tostring date-time

Enquiries received up to

pageNumberinteger

Page number for paginated results (25 per page)

Response

OK

deliveryMethod'email' | 'sms' nullable
enquiryType'listing' | 'devProject' | 'newDevLanding' | 'agencyProfile' | 'agentProfile' | 'contractRequest' | 'vendorEnquiry' | 'prePortalListing' | 'suburbVendorEnquiry' nullable
idstring nullable
messagestring nullable
metaDataobject nullable
referenceIdinteger nullable
dateReceivedstring date-time nullable
agencyIdinteger nullable

Changes

  • 7130302fb268Revision changes
    • warning

      added the new suburbVendorEnquiry enum value to the / response property for the response status