aryeo_list_orders
List orders
List the orders of your Aryeo company (newest first by default), with payment status, fulfillment status, totals and links. Filter by search text (address or customer), payment/fulfillment status, appointment date range, tags or assigned users. GET /orders.
Parameterspagesortsearchincludetag_idsper_pageuser_idspayment_statuscreator_group_idfulfillment_statusappointment_start_afterappointment_start_before
One order by id: customer, address, status, totals, payment and invoice links. Add include=items,appointments,listing,customer for the line items and visits. GET /orders/{id}.
Parametersincludeorder_idrequired
aryeo_update_order_notes
Update order notes
REPLACE the internal notes of an order (visible to your team only, not to the customer). The whole note is overwritten: read the order first and send the full new text. An empty string clears the notes. PUT /orders/{id}/notes.
Parametersorder_idrequiredinternal_notesrequired
aryeo_list_appointments
List appointments
List appointments (shoots/visits), by default the SCHEDULED ones, newest start first. Filter by upcoming/past, status, a start-time window or the assigned users. Use include=order,order.address,users to see where and who. GET /appointments.
Parameterspagesorttenseincludeper_pagestatusesuser_idsstart_afterstart_before
aryeo_get_appointment
Get appointment
One appointment by id: status, start/end, duration, assigned users and items. GET /appointments/{id}.
Parametersincludeappointment_idrequired
aryeo_cancel_appointment
Cancel appointment
CANCEL an appointment. With notify=true Aryeo sends a cancellation notice to the order's customer (an email/message to a third party); with notify=false nobody is told. Cancelling can trigger fees or free the slot for other bookings. PUT /appointments/{id}/cancel.
Parametersnotifyrequiredappointment_idrequired
aryeo_reschedule_appointment
Reschedule appointment
MOVE an appointment to a new start and end time. With notify=true Aryeo sends a reschedule notice to the order's customer (a message to a third party). Check availability first (aryeo_list_available_timeslots). PUT /appointments/{id}/reschedule.
Parametersend_atrequirednotifyrequiredstart_atrequiredappointment_idrequired
aryeo_list_available_timeslots
List available timeslots
Bookable timeslots for ONE day (in the given timezone) for a proposed or existing appointment. Give either appointment_id, or duration + interval (minutes). Optionally restrict to users and tie it to an order. GET /scheduling/available-timeslots.
Parametersdaterequiredpagedurationintervalorder_idper_pagetimezonerequireduser_idsappointment_idorder_item_ids
aryeo_list_available_dates
List available dates
Days that still have availability for a proposed or existing appointment: give a start/end range or a timeframe, plus either appointment_id or duration + interval (minutes). GET /scheduling/available-dates.
Parameterspageend_atdurationintervalorder_idper_pagestart_attimezonerequireduser_idstimeframeappointment_idorder_item_ids
aryeo_list_listings
List listings
List the property listings of your Aryeo company (address, status, price, bedrooms, delivery status, thumbnails). Filter by search text, address, listing agent, status, price/size ranges or delivery status. GET /listings.
Parameterspagesortactivesearchstatusaddressincludeper_pageprice_maxprice_minlist_agentbedrooms_max+6 more
aryeo_get_listing
Get listing
One listing by id: address, status, price, lot/building details, agents. Add include=images,videos,orders.appointments for media and visits. GET /listings/{id}.
Parametersincludelisting_idrequired
aryeo_get_listing_stats
Get listing statistics
Viewing statistics of a listing's property website (visits, views). GET /listings/{id}/stats.
Parameterslisting_idrequired
aryeo_list_customers
List customers
List your customers (the agents, brokerages and teams who order from you) with contact details and balances. Filter by name, email, email domain, phone or search text. GET /customers.
Parametersnamepagesortemailphonesearchincludeper_pageemail_domaincustomer_team_ids
aryeo_create_customer
Create customer
Create a customer (an agent or brokerage that can place orders) in your Aryeo company from an owner name and email. Look the email up with aryeo_list_customers first to avoid duplicates. Aryeo may email the new customer an invitation. POST /customers.
Parametersemailrequiredphonetimezoneteam_namedescriptionoffice_namewebsite_urllicense_numberowner_last_namerequiredowner_first_namerequired
aryeo_list_products
List products
List your services/products (main products and add-ons) with type, active state and variants. Inactive products are hidden unless include_inactive is true. GET /products.
Parameterspagesorttypesearchper_pagecategory_idsinclude_inactive
aryeo_list_product_categories
List product categories
List the product categories (use the ids to filter aryeo_list_products). GET /product-categories.
Parameterspagesortsearchper_page
aryeo_list_coupons
List coupons
List discount coupons (name, percent or amount off, active state, times redeemed). GET /coupons.
Parameterspagesortsearchincludeper_page
aryeo_list_order_forms
List order forms
List your order forms (the public booking forms customers use), with title, URL and scheduling settings. GET /order-forms.
Parameterspageper_page
aryeo_list_team_members
List team members
List your company's team members (photographers and staff) with role, status, service-provider flag and permissions. Each member has two ids: the member `id` (for aryeo_list_team_member_events and as the task assignee company_team_member_id) and `company_user.id` (the USER id, for the user_ids filters of orders, appointments, timeslots and dates). company_user is included by default. GET /company-team-members.
Parameterspagesearchincludeper_page
aryeo_list_team_member_events
List team member calendar
A team member's calendar between two moments: appointments, blocks, external events and buffers. Use aryeo_list_team_members for the id. GET /company-team-members/{id}/events.
Parametersendtypestartteam_member_idrequiredinclude_unscheduled
aryeo_list_tasks
List tasks
List tasks (to-dos such as editing or delivery steps) with assignee, due date and completion state. GET /tasks.
Takes no parameters.
One task by id. GET /tasks/{id}.
Parameterstask_idrequired
aryeo_create_task
Create task
Create a task, optionally with a description, due date and an assignee (a company team member id). POST /tasks.
Parametersnamerequireddue_atdescriptioncompany_team_member_id
aryeo_complete_task
Complete task
Mark a task completed (now, or at the given time). PUT /tasks/{id}/complete.
Parameterstask_idrequiredcompleted_at