Aryeo icon

Aryeo

Real estate media production platform for orders, appointments, and delivery workflows.

7 searches15 actionsPollingAuth: API key

AI-assisted documentation19 min read

This documentation is compiled from our integration source code, internal specs for Aryeo, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Aryeo on WEXTL →

To use Aryeo on WEXTL you need an active account and an API access token from your account settings.[3]

  • API KeypasswordRequired

    You can view and manage your API keys in the dashboard.

    [1]
  1. Log in to your WEXTL account, add the Aryeo node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Aryeo account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Connecting Aryeo to WEXTL®
Video slide demonstrates how to integrate Aryeo in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Get a ListingAction
Input fields[3]
FieldType
Listing IDRequired
choice
Output fields[3]
FieldType
Objecttext
IDtext
Addressobject
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
Mls numbertext
Typetext
Sub typetext
Statustext
Standard statustext
Thumbnail URLtext
Large thumbnail URLtext
Descriptiontext
Lotobject
Size acresnumber
Open parking spacesnumber
Buildingobject
Bedroomsnumber
Bathroomsnumber
Square feetnumber
Year builtnumber
Bedrooms numbernumber
Priceobject
List pricenumber
List price formattedtext
List agentobject
Objecttext
IDtext
Typetext
Nametext
Emailtext
Phonetext
Website URLtext
Logo URLtext
Office nametext
License numbertext
Co list agentobject
Objecttext
IDtext
Typetext
Nametext
Emailtext
Phonetext
Website URLtext
Logo URLtext
Office nametext
License numbertext
Customer team membershipsarray
Imagesarray
Videosarray
Floor plansarray
12other output fields
Get an AddressAction
Input fields[3]
FieldType
Address IDRequired
text
Output fields[3]
FieldType
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
State or provincetext
State or province regiontext
Countrytext
Country regiontext
Timezonetext
Unparsed addresstext
Unparsed address part onetext
Unparsed address part twotext
Is map dirtyboolean
Get an AppointmentAction
Input fields[3]
FieldType
Appointment IDRequired
choice
Output fields[3]
FieldType
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
State or provincetext
State or province regiontext
Countrytext
Country regiontext
Timezonetext
Unparsed addresstext
Unparsed address part onetext
Unparsed address part twotext
Is map dirtyboolean
Get an OrderAction
Input fields[3]
FieldType
Order IDRequired
choice
Output fields[3]
FieldType
Objecttext
IDtext
Identifiertext
Numbernumber
Titletext
Statustext
Order statustext
Is ghostboolean
Fulfilled attext
Fulfillment statustext
Payment statustext
Internal notestext
Currencytext
Total amountnumber
Payment URLtext
Status URLtext
Invoice URLtext
Downloads allowedboolean
Payments allowedboolean
Addressobject
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
22other output fields
Search AppointmentsSearch
Input fields[3]
FieldType
Includechoice
Filter by Tensechoice
Filter by Statusesarray
Start At (Greater Than or Equal)date
Start At (Less Than or Equal)date
Filter by User IDsarray
User IDtext
Sorttext
Limitnumber
Output fields[3]
FieldType
IDtext
Statustext
Titletext
Descriptiontext
Start atdate
End atdate
Rescheduled atdate
Postponed atdate
Previous start atdate
Preference typetext
Preferred start atdate
Preferred start at daytext
Preferred start at time of daytime
Durationnumber
User has appointments manage permissionboolean
Orderobject
Objecttext
IDtext
Identifiertext
Numbernumber
Titletext
Statustext
Order statustext
Is ghostboolean
Fulfilled atdate
Fulfillment statustext
Usersarray
Itemsarray
Can cancelboolean
Can rescheduleboolean
8other output fields
Search ListingsSearch
Input fields[3]
FieldType
Includechoice
Searchtext
Addresstext
List Agenttext
Statuschoice
Activeboolean
Price (Greater Than or Equal)number
Price (Less Than or Equal)number
Square Feet (Greater Than or Equal)number
Square Feet (Less Than or Equal)number
Bedrooms (Greater Than or Equal)number
Bedrooms (Less Than or Equal)number
Bathrooms (Greater Than or Equal)number
Bathrooms (Less Than or Equal)number
Delivery Statuschoice
Showcaseboolean
Sorttext
Limitnumber
Output fields[3]
FieldType
Objecttext
IDtext
Addressobject
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
Mls numbertext
Typetext
Sub typetext
Statustext
Standard statustext
Thumbnail URLtext
Large thumbnail URLtext
Descriptiontext
Lotobject
Size acresnumber
Open parking spacesnumber
Buildingobject
Bedroomsnumber
Bathroomsnumber
Square feetnumber
Year builtnumber
Bedrooms numbernumber
Priceobject
List pricenumber
List price formattedtext
List agentobject
Objecttext
IDtext
Typetext
Nametext
Emailtext
Phonetext
Website URLtext
Logo URLtext
Office nametext
License numbertext
Co list agentobject
Objecttext
IDtext
Typetext
Nametext
Emailtext
Phonetext
Website URLtext
Logo URLtext
Office nametext
License numbertext
Customer team membershipsarray
Imagesarray
Videosarray
Floor plansarray
12other output fields
Search OrdersSearch
Input fields[3]
FieldType
Includechoice
Searchtext
Payment Statuschoice
Fulfillment Statuschoice
Appointment Start At (Greater Than or Equal)date
Appointment Start At (Less Than or Equal)date
Creator Group IDtext
Tag IDsarray
Tag IDtext
User IDsarray
User IDchoice
Sorttext
Limitnumber
Output fields[3]
FieldType
Objecttext
IDtext
Identifiertext
Numbernumber
Titletext
Statustext
Order statustext
Is ghostboolean
Fulfilled attext
Fulfillment statustext
Payment statustext
Internal notestext
Currencytext
Total amountnumber
Payment URLtext
Status URLtext
Invoice URLtext
Downloads allowedboolean
Payments allowedboolean
Addressobject
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
22other output fields
Accept an AppointmentAction
Input fields[3]
FieldType
Appointment IDRequired
choice
Output fields[3]
FieldType
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
State or provincetext
State or province regiontext
Countrytext
Country regiontext
Timezonetext
Unparsed addresstext
Unparsed address part onetext
Unparsed address part twotext
Is map dirtyboolean
Cancel an AppointmentAction
Input fields[3]
FieldType
Appointment IDRequired
choice
Notifyboolean
Output fields[3]
FieldType
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
State or provincetext
State or province regiontext
Countrytext
Country regiontext
Timezonetext
Unparsed addresstext
Unparsed address part onetext
Unparsed address part twotext
Is map dirtyboolean
Create a ListingAction
Input fields[3]
FieldType
Address IDRequired
text
List Agent IDchoice
Co-List Agent IDchoice
Order IDsarray
Order IDchoice
Sectionsobject
Imagesboolean
Videosboolean
Floor Plansboolean
Interactive Contentboolean
Output fields[3]
FieldType
Objecttext
IDtext
Addressobject
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
Mls numbertext
Typetext
Sub typetext
Statustext
Standard statustext
Thumbnail URLtext
Large thumbnail URLtext
Descriptiontext
Lotobject
Size acresnumber
Open parking spacesnumber
Buildingobject
Bedroomsnumber
Bathroomsnumber
Square feetnumber
Year builtnumber
Bedrooms numbernumber
Priceobject
List pricenumber
List price formattedtext
List agentobject
Objecttext
IDtext
Typetext
Nametext
Emailtext
Phonetext
Website URLtext
Logo URLtext
Office nametext
License numbertext
Co list agentobject
Objecttext
IDtext
Typetext
Nametext
Emailtext
Phonetext
Website URLtext
Logo URLtext
Office nametext
License numbertext
Customer team membershipsarray
Imagesarray
Videosarray
Floor plansarray
12other output fields
Create an AddressAction
Input fields[3]
FieldType
LatitudeRequired
number
LongitudeRequired
number
Street Numbertext
Street Nametext
Unit Numbertext
Postal Codetext
Citytext
City Regiontext
County or Parishtext
State or Provincetext
State or Province Regiontext
Countrytext
Country Regiontext
Output fields[3]
FieldType
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
State or provincetext
State or province regiontext
Countrytext
Country regiontext
Timezonetext
Unparsed addresstext
Unparsed address part onetext
Unparsed address part twotext
Is map dirtyboolean
Create an AppointmentAction
Input fields[3]
FieldType
Start AtRequired
date
End AtRequired
date
User IDsarray
User IDchoice
Item IDsarray
Item IDtext
Notifyboolean
Output fields[3]
FieldType
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
State or provincetext
State or province regiontext
Countrytext
Country regiontext
Timezonetext
Unparsed addresstext
Unparsed address part onetext
Unparsed address part twotext
Is map dirtyboolean
Create an OrderAction
Input fields[3]
FieldType
Fulfillment Statuschoice
Internal Notestext
Address IDtext
Customer IDchoice
Company IDtext
Customer Team Membership IDtext
Listing IDchoice
Notifyboolean
Lock Download for Paymentboolean
Allow Payments Before Fulfillmentboolean
Product Itemsarray
Output fields[3]
FieldType
Objecttext
IDtext
Identifiertext
Numbernumber
Titletext
Statustext
Order statustext
Is ghostboolean
Fulfilled attext
Fulfillment statustext
Payment statustext
Internal notestext
Currencytext
Total amountnumber
Payment URLtext
Status URLtext
Invoice URLtext
Downloads allowedboolean
Payments allowedboolean
Addressobject
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
22other output fields
Create an Order ItemAction
Input fields[3]
FieldType
Order IDRequired
choice
Product Variant IDchoice
QuantityRequired
number
Unit Price Amountnumber
Titletext
Subtitletext
Descriptiontext
Appointment IDchoice
Assigned Company Team Member IDchoice
Output fields[3]
FieldType
Objecttext
IDtext
Titletext
Subtitletext
Sub titletext
Descriptiontext
Purchasable typetext
Amountnumber
Unit price amountnumber
Quantitynumber
Gross total amountnumber
Appointmentobject
IDtext
Statustext
Titletext
Descriptiontext
Start attext
End attext
Rescheduled attext
Postponed attext
Previous start attext
Preference typetext
Discountsarray
Orderobject
Objecttext
IDtext
Identifiertext
Numbernumber
Titletext
Statustext
Order statustext
Is ghostboolean
Fulfilled attext
Fulfillment statustext
Productobject
Objecttext
IDtext
Titletext
Descriptiontext
Activeboolean
Typetext
Is twilightboolean
Image URLtext
Is serviceableboolean
Requires separate bookingboolean
Product variantobject
Objecttext
IDtext
Titletext
Pricenumber
Price amountnumber
Base price amountnumber
Base is hiddenboolean
Display original priceboolean
Durationnumber
Taxesarray
Is serviceableboolean
Tasksarray
Is canceledboolean
Decline an AppointmentAction
Input fields[3]
FieldType
Appointment IDRequired
choice
Output fields[3]
FieldType
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
State or provincetext
State or province regiontext
Countrytext
Country regiontext
Timezonetext
Unparsed addresstext
Unparsed address part onetext
Unparsed address part twotext
Is map dirtyboolean
Delete an Order ItemAction
Input fields[3]
FieldType
Order Item IDRequired
text
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Reschedule an AppointmentAction
Input fields[3]
FieldType
Appointment IDRequired
choice
Start AtRequired
date
End AtRequired
date
Notifyboolean
Output fields[3]
FieldType
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
State or provincetext
State or province regiontext
Countrytext
Country regiontext
Timezonetext
Unparsed addresstext
Unparsed address part onetext
Unparsed address part twotext
Is map dirtyboolean
Update a ListingAction
Input fields[3]
FieldType
Listing IDRequired
choice
Titletext
Descriptiontext
Statustext
MLS Live Datedate
MLS Numbertext
Pricenumber
Bedroomsnumber
Bathroomsnumber
Home Square Footagenumber
Lot Acresnumber
Parking Spotsnumber
Year Builtnumber
Property Typetext
Is Showcaseboolean
Output fields[3]
FieldType
Objecttext
IDtext
Addressobject
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
Mls numbertext
Typetext
Sub typetext
Statustext
Standard statustext
Thumbnail URLtext
Large thumbnail URLtext
Descriptiontext
Lotobject
Size acresnumber
Open parking spacesnumber
Buildingobject
Bedroomsnumber
Bathroomsnumber
Square feetnumber
Year builtnumber
Bedrooms numbernumber
Priceobject
List pricenumber
List price formattedtext
List agentobject
Objecttext
IDtext
Typetext
Nametext
Emailtext
Phonetext
Website URLtext
Logo URLtext
Office nametext
License numbertext
Co list agentobject
Objecttext
IDtext
Typetext
Nametext
Emailtext
Phonetext
Website URLtext
Logo URLtext
Office nametext
License numbertext
Customer team membershipsarray
Imagesarray
Videosarray
Floor plansarray
12other output fields
Update an AddressAction
Input fields[3]
FieldType
Address IDRequired
text
Latitudenumber
Longitudenumber
Street Numbertext
Street Nametext
Unit Numbertext
Postal Codetext
Citytext
City Regiontext
County or Parishtext
State or Provincetext
State or Province Regiontext
Countrytext
Country Regiontext
Output fields[3]
FieldType
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
State or provincetext
State or province regiontext
Countrytext
Country regiontext
Timezonetext
Unparsed addresstext
Unparsed address part onetext
Unparsed address part twotext
Is map dirtyboolean
Update an AppointmentAction
Input fields[3]
FieldType
Appointment IDRequired
choice
Start Atdate
End Atdate
User IDsarray
User IDtext
Item IDsarray
Item IDtext
Notifyboolean
Output fields[3]
FieldType
IDtext
Latitudenumber
Longitudenumber
Street numbertext
Street nametext
Unit numbertext
Postal codetext
Citytext
City regiontext
County or parishtext
State or provincetext
State or province regiontext
Countrytext
Country regiontext
Timezonetext
Unparsed addresstext
Unparsed address part onetext
Unparsed address part twotext
Is map dirtyboolean
Update an Order ItemAction
Input fields[3]
FieldType
Order Item IDRequired
text
Titletext
Product Variant IDchoice
Quantitynumber
Unit Price Amountnumber
Subtitletext
Descriptiontext
Appointment IDchoice
Assigned Company Team Member IDchoice
Output fields[3]
FieldType
Objecttext
IDtext
Titletext
Subtitletext
Sub titletext
Descriptiontext
Purchasable typetext
Amountnumber
Unit price amountnumber
Quantitynumber
Gross total amountnumber
Appointmentobject
IDtext
Statustext
Titletext
Descriptiontext
Start attext
End attext
Rescheduled attext
Postponed attext
Previous start attext
Preference typetext
Discountsarray
Orderobject
Objecttext
IDtext
Identifiertext
Numbernumber
Titletext
Statustext
Order statustext
Is ghostboolean
Fulfilled attext
Fulfillment statustext
Productobject
Objecttext
IDtext
Titletext
Descriptiontext
Activeboolean
Typetext
Is twilightboolean
Image URLtext
Is serviceableboolean
Requires separate bookingboolean
Product variantobject
Objecttext
IDtext
Titletext
Pricenumber
Price amountnumber
Base price amountnumber
Base is hiddenboolean
Display original priceboolean
Durationnumber
Taxesarray
Is serviceableboolean
Tasksarray
Is canceledboolean

Look for Aryeo templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Aryeo Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Aryeo.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:38