API Reference
/
Appointments

The Aryeo API provides access to the Aryeo platform.

Overview
URL

https://www.aryeo.com

Admin

jarrodp@zillowgroup.com

License

Apache 2.0

Terms of Service

Languages
Servers
Mock server

https://docs.aryeo.com/_mock/api/aryeo/

Production

https://api.aryeo.com/v1/

Addresses

Operations related to addresses.

Operations

Appointments

Operations related to appointments.

Operations

List appointments.

Request

List appointments. By default, returns a list of appointments that have been scheduled and have not been canceled

external: true
Query
includestring[ 0 .. 255 ] characters

Comma separated list of optional data to include in the response.

Example: include=owner,items,users,order,order.address,order.customer,order.customerGroup,order.listing,order.items,order.items.appointment
filter[tense]string[ 1 .. 100 ] characters

Return appointments that are upcoming or in the past.

Enum"PAST""UPCOMING"
Example: filter[tense]=UPCOMING
filter[statuses][]Array of strings

Filters appointment by status, defaults to SCHEDULED.

Items Enum"SCHEDULED""UNSCHEDULED""CANCELED"
Example: filter[statuses][]=SCHEDULED
filter[start_at_gte]string(date-time)= 20 characters

Return appointments where the start_at field is greater than or equal to this value. Effectively, appointments that start after this date.

Example: filter[start_at_gte]=2021-01-01T13:00:00Z
filter[start_at_lte]string(date-time)= 20 characters

Return appointments where the start_at field is less than or equal to this value. Effectively, appointments that start before this date.

Example: filter[start_at_lte]=2021-01-02T13:00:00Z
filter[user_ids][]Array of strings(uuid)

The IDs of users whose appointments will be listed. UUID Version 4.

Example: filter[user_ids][]=00000000-0000-4000-8000-000000000000
sortstring[ 1 .. 100 ] characters

Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to -start_at.

Example: sort=-created_at
per_pagestring[ 1 .. 5 ] characters

The number of items per page. Defaults to 25.

Example: per_page=25
pagestring[ 1 .. 5 ] characters

The requested page. Defaults to 1.

Example: page=2
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

AppointmentCollection

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataArray of objects or null(Appointment)

A collection of objects.

metaobject(PaginationMeta)

Metadata about a paginated response.

linksobject(PaginationLinks)

Related links for a paginated response.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "status": "SCHEDULED",
      "title": "Appointment title",
      "description": "Customer: John Doe\nOrder Details: Order #123",
      "start_at": "2021-06-30T20:30:00Z",
      "end_at": "2021-06-30T20:30:00Z",
      "rescheduled_at": "2021-06-30T20:30:00Z",
      "postponed_at": "2021-06-30T20:30:00Z",
      "previous_start_at": "2021-06-30T20:30:00Z",
      "preference_type": "TIME",
      "preferred_start_at": "2021-06-30T20:30:00Z",
      "preferred_start_at_day": "2021-06-30",
      "preferred_start_at_time_of_day": "AFTERNOON",
      "duration": 60,
      "user_has_appointments_manage_permission": true,
      "order": {
        "object": "ORDER",
        "id": "00000000-0000-4000-8000-000000000000",
        "identifier": "Order #2",
        "number": 100,
        "title": "Order #100",
        "status": "GHOST",
        "order_status": "OPEN",
        "is_ghost": true,
        "fulfilled_at": "2021-06-30T20:30:00Z",
        "fulfillment_status": "FULFILLED",
        "payment_status": "PAID",
        "internal_notes": "Hey there notes!",
        "currency": "USD",
        "total_amount": 2099,
        "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order",
        "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status",
        "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download",
        "downloads_allowed": true,
        "payments_allowed": true,
        "address": {
          "id": "00000000-0000-4000-8000-000000000000",
          "latitude": 42.35157458574123,
          "longitude": -71.05763741484657,
          "street_number": "107",
          "street_name": "South St",
          "unit_number": "Unit 2F",
          "postal_code": "02111",
          "city": "Boston",
          "city_region": "Leather District",
          "county_or_parish": "Suffolk County",
          "state_or_province": "MA",
          "state_or_province_region": "Cape Cod",
          "country": "US",
          "country_region": "Napa Valley",
          "timezone": "America/New_York",
          "unparsed_address": "107 South St, Boston MA, 02111",
          "unparsed_address_part_one": "107 South St, Unit 2F",
          "unparsed_address_part_two": "Boston, MA 02111",
          "is_map_dirty": true
        },
        "customer": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "customer_group": {
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John Doe Customer Group",
          "affiliate_id": "JOHN_DOE",
          "billing_customer": { … }
        },
        "listing": {
          "object": "LISTING",
          "id": "00000000-0000-4000-8000-000000000000",
          "address": { … },
          "mls_number": "1850209",
          "type": "RESIDENTIAL",
          "sub_type": "SINGLE_FAMILY_RESIDENCE",
          "status": "COMING_SOON",
          "standard_status": "COMING_SOON",
          "thumbnail_url": "https://picsum.photos/640/480",
          "large_thumbnail_url": "https://picsum.photos/1280/960",
          "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.",
          "lot": { … },
          "building": { … },
          "price": { … },
          "list_agent": { … },
          "co_list_agent": { … },
          "customer_team_memberships": [ … ],
          "images": [ … ],
          "videos": [ … ],
          "floor_plans": [ … ],
          "interactive_content": [ … ],
          "property_website": { … },
          "marketing_materials": [ … ],
          "orders": [ … ],
          "appointments": [ … ],
          "unconfirmed_appointments": [ … ],
          "downloads_enabled": true,
          "is_showcase": true,
          "is_showcasable": true,
          "has_high_resolution_images": true,
          "has_zillow_imx_tour": true,
          "delivery_status": "DELIVERED"
        },
        "order_form": {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": "{}",
          "owner": { … },
          "company": { … }
        },
        "discounts": [
          { … }
        ],
        "tags": [
          { … }
        ],
        "items": [
          { … }
        ],
        "custom_items": [
          { … }
        ],
        "appointments": [
          {}
        ],
        "unconfirmed_appointments": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "updated_at": "2021-06-30T20:30:00Z",
        "custom_fields": [
          {}
        ],
        "taxes": [
          { … }
        ],
        "booking_limits": {
          "object": "COMPANY",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "is_twilight_visible": true
        },
        "filter_by_square_feet": true,
        "filter_by_list_price": true,
        "scheduling_assignment_strategy": "RECOMMENDED",
        "balance_amount": 2099,
        "total_tax_amount": 2099,
        "total_discount_amount": 2099,
        "payments": [
          { … }
        ]
      },
      "users": [
        {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true
        }
      ],
      "items": [
        {
          "object": "ORDER_ITEM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Aerial Video",
          "subtitle": "10 minute video",
          "sub_title": "10 minute video",
          "description": "A fly-by drone video of the property.",
          "purchasable_type": "FEE",
          "amount": 2099,
          "unit_price_amount": 2099,
          "quantity": 2,
          "gross_total_amount": 4198,
          "appointment": {},
          "discounts": [ … ],
          "order": { … },
          "product": { … },
          "product_variant": { … },
          "taxes": [ … ],
          "is_serviceable": true,
          "tasks": [ … ],
          "is_canceled": true
        }
      ],
      "can_cancel": true,
      "can_reschedule": true,
      "is_within_cancellation_lock_period": true,
      "is_within_rescheduling_lock_period": true,
      "deleted_at": "2021-06-30T20:30:00Z",
      "requires_confirmation": true,
      "late_cancellation_fee": [
        {}
      ],
      "updated_at": "2021-06-30T20:30:00Z",
      "company_team_members": [
        {
          "object": "COMPANY_TEAM_MEMBER",
          "id": "00000000-0000-4000-8000-000000000000",
          "calendar_color": "#FF0000",
          "permissions": [ … ],
          "restrictions": [ … ],
          "is_service_provider": true,
          "external_id": "1234567890",
          "company_user": { … }
        }
      ],
      "appointment_attendances": [
        {
          "object": "APPOINTMENT_ATTENDANCE",
          "id": 1234567890,
          "company_team_member": { … },
          "zillow_3d_home_deep_link_url": "https://aryeo.com",
          "is_requested": true,
          "accepted_at": "2021-06-30T20:30:00Z",
          "declined_at": "2021-06-30T20:30:00Z"
        }
      ]
    }
  ],
  "meta": {
    "total": 50,
    "per_page": 15,
    "current_page": 1,
    "last_page": 4,
    "from": 1,
    "to": 15,
    "path": "https://api.aryeo.com/v1/{path}",
    "links": [
      {
        "url": "https://admin.aryeo.test/api/v1/companies?page=2",
        "label": "2",
        "active": true
      }
    ]
  },
  "links": {
    "first": "https://api.aryeo.com/v1/{path}?page=1",
    "last": "https://api.aryeo.com/v1/{path}?page=10",
    "prev": "https://api.aryeo.com/v1/{path}?page=2",
    "next": "https://api.aryeo.com/v1/{path}?page=3"
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Get appointment.

Request

Get appointment.

external: true
Path
appointment_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an appointment.

Example: 00000000-0000-4000-8000-000000000000
Query
includestring[ 0 .. 255 ] characters

Comma separated list of optional data to include in the response.

Example: include=owner,items,users,order,order.address,order.customer,order.customerGroup, order.listing,order.items,.order.items.appointment
const appointmentId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/${appointmentId}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

AppointmentResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Appointment)

An appointment.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "status": "SCHEDULED",
    "title": "Appointment title",
    "description": "Customer: John Doe\nOrder Details: Order #123",
    "start_at": "2021-06-30T20:30:00Z",
    "end_at": "2021-06-30T20:30:00Z",
    "rescheduled_at": "2021-06-30T20:30:00Z",
    "postponed_at": "2021-06-30T20:30:00Z",
    "previous_start_at": "2021-06-30T20:30:00Z",
    "preference_type": "TIME",
    "preferred_start_at": "2021-06-30T20:30:00Z",
    "preferred_start_at_day": "2021-06-30",
    "preferred_start_at_time_of_day": "AFTERNOON",
    "duration": 60,
    "user_has_appointments_manage_permission": true,
    "order": {
      "object": "ORDER",
      "id": "00000000-0000-4000-8000-000000000000",
      "identifier": "Order #2",
      "number": 100,
      "title": "Order #100",
      "status": "GHOST",
      "order_status": "OPEN",
      "is_ghost": true,
      "fulfilled_at": "2021-06-30T20:30:00Z",
      "fulfillment_status": "FULFILLED",
      "payment_status": "PAID",
      "internal_notes": "Hey there notes!",
      "currency": "USD",
      "total_amount": 2099,
      "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order",
      "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status",
      "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download",
      "downloads_allowed": true,
      "payments_allowed": true,
      "address": {
        "id": "00000000-0000-4000-8000-000000000000",
        "latitude": 42.35157458574123,
        "longitude": -71.05763741484657,
        "street_number": "107",
        "street_name": "South St",
        "unit_number": "Unit 2F",
        "postal_code": "02111",
        "city": "Boston",
        "city_region": "Leather District",
        "county_or_parish": "Suffolk County",
        "state_or_province": "MA",
        "state_or_province_region": "Cape Cod",
        "country": "US",
        "country_region": "Napa Valley",
        "timezone": "America/New_York",
        "unparsed_address": "107 South St, Boston MA, 02111",
        "unparsed_address_part_one": "107 South St, Unit 2F",
        "unparsed_address_part_two": "Boston, MA 02111",
        "is_map_dirty": true
      },
      "customer": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": "{}",
          "owner": {},
          "company": {}
        },
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          { … }
        ],
        "owner": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_visible": true,
        "order_index": 1
      },
      "customer_group": {
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "John Doe Customer Group",
        "affiliate_id": "JOHN_DOE",
        "billing_customer": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        }
      },
      "listing": {
        "object": "LISTING",
        "id": "00000000-0000-4000-8000-000000000000",
        "address": {
          "id": "00000000-0000-4000-8000-000000000000",
          "latitude": 42.35157458574123,
          "longitude": -71.05763741484657,
          "street_number": "107",
          "street_name": "South St",
          "unit_number": "Unit 2F",
          "postal_code": "02111",
          "city": "Boston",
          "city_region": "Leather District",
          "county_or_parish": "Suffolk County",
          "state_or_province": "MA",
          "state_or_province_region": "Cape Cod",
          "country": "US",
          "country_region": "Napa Valley",
          "timezone": "America/New_York",
          "unparsed_address": "107 South St, Boston MA, 02111",
          "unparsed_address_part_one": "107 South St, Unit 2F",
          "unparsed_address_part_two": "Boston, MA 02111",
          "is_map_dirty": true
        },
        "mls_number": "1850209",
        "type": "RESIDENTIAL",
        "sub_type": "SINGLE_FAMILY_RESIDENCE",
        "status": "COMING_SOON",
        "standard_status": "COMING_SOON",
        "thumbnail_url": "https://picsum.photos/640/480",
        "large_thumbnail_url": "https://picsum.photos/1280/960",
        "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.",
        "lot": {
          "size_acres": 0.47,
          "open_parking_spaces": 3
        },
        "building": {
          "bedrooms": 4,
          "bathrooms": 3.5,
          "square_feet": 2511,
          "year_built": 1960,
          "bedrooms_number": 4
        },
        "price": {
          "list_price": 250000,
          "list_price_formatted": "$250,000"
        },
        "list_agent": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "co_list_agent": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "customer_team_memberships": [
          { … }
        ],
        "images": [
          { … }
        ],
        "videos": [
          { … }
        ],
        "floor_plans": [
          { … }
        ],
        "interactive_content": [
          { … }
        ],
        "property_website": {
          "id": "00000000-0000-4000-8000-000000000000",
          "branded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/branded",
          "unbranded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/unbranded"
        },
        "marketing_materials": [
          { … }
        ],
        "orders": [
          {}
        ],
        "appointments": [
          {}
        ],
        "unconfirmed_appointments": [
          {}
        ],
        "downloads_enabled": true,
        "is_showcase": true,
        "is_showcasable": true,
        "has_high_resolution_images": true,
        "has_zillow_imx_tour": true,
        "delivery_status": "DELIVERED"
      },
      "order_form": {
        "object": "ORDER_FORM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "BQ's Photography Order Form",
        "type": "ARYEO",
        "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
        "is_public": true,
        "thumbnail_url": "https://picsum.photos/300",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "require_upfront_payment": true,
        "upfront_payment_percentage": 50,
        "use_instant_appointment_scheduling": true,
        "form_settings": "{}",
        "owner": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "company": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        }
      },
      "discounts": [
        {
          "object": "DISCOUNT",
          "id": "00000000-0000-4000-8000-000000000000",
          "total_discount_amount": 1000,
          "coupon": { … }
        }
      ],
      "tags": [
        {
          "object": "APP\\TAGS\\MODELS\\TAG",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "Photography",
          "slug": "photography",
          "color": "#8BC34A",
          "font_color": "#FFFFFF"
        }
      ],
      "items": [
        {
          "object": "ORDER_ITEM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Aerial Video",
          "subtitle": "10 minute video",
          "sub_title": "10 minute video",
          "description": "A fly-by drone video of the property.",
          "purchasable_type": "FEE",
          "amount": 2099,
          "unit_price_amount": 2099,
          "quantity": 2,
          "gross_total_amount": 4198,
          "appointment": {},
          "discounts": [ … ],
          "order": {},
          "product": { … },
          "product_variant": { … },
          "taxes": [ … ],
          "is_serviceable": true,
          "tasks": [ … ],
          "is_canceled": true
        }
      ],
      "custom_items": [
        {
          "object": "ORDER_ITEM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Aerial Video",
          "subtitle": "10 minute video",
          "sub_title": "10 minute video",
          "description": "A fly-by drone video of the property.",
          "purchasable_type": "FEE",
          "amount": 2099,
          "unit_price_amount": 2099,
          "quantity": 2,
          "gross_total_amount": 4198,
          "appointment": {},
          "discounts": [ … ],
          "order": {},
          "product": { … },
          "product_variant": { … },
          "taxes": [ … ],
          "is_serviceable": true,
          "tasks": [ … ],
          "is_canceled": true
        }
      ],
      "appointments": [
        {}
      ],
      "unconfirmed_appointments": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "updated_at": "2021-06-30T20:30:00Z",
      "custom_fields": [
        {}
      ],
      "taxes": [
        {
          "object": "TAX",
          "id": "00000000-0000-4000-8000-000000000000",
          "total_tax_amount": 2099,
          "applied_rate": 0.075,
          "tax_rate": { … }
        }
      ],
      "booking_limits": {
        "object": "COMPANY",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "is_twilight_visible": true
      },
      "filter_by_square_feet": true,
      "filter_by_list_price": true,
      "scheduling_assignment_strategy": "RECOMMENDED",
      "balance_amount": 2099,
      "total_tax_amount": 2099,
      "total_discount_amount": 2099,
      "payments": [
        {
          "object": "ORDER_PAYMENT",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "MANUAL",
          "collection_source": "CASH",
          "completed_at": "2021-06-30T20:30:00Z",
          "applicable_amount": 502,
          "tip_amount": 100,
          "total_amount": 502,
          "collected_amount": 502,
          "order": {}
        }
      ]
    },
    "users": [
      {
        "object": "PERSONAL_ACCESS_TOKEN",
        "id": "00000000-0000-4000-8000-000000000000",
        "email": "john.doe@gmail.com",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "internal_notes": "Internal notes for the user.",
        "status": "active",
        "phone": "123456789",
        "avatar_url": "https://picsum.photos/300",
        "relationship": "owner",
        "sso_users": [
          { … }
        ],
        "is_super": true
      }
    ],
    "items": [
      {
        "object": "ORDER_ITEM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "Aerial Video",
        "subtitle": "10 minute video",
        "sub_title": "10 minute video",
        "description": "A fly-by drone video of the property.",
        "purchasable_type": "FEE",
        "amount": 2099,
        "unit_price_amount": 2099,
        "quantity": 2,
        "gross_total_amount": 4198,
        "appointment": {},
        "discounts": [
          { … }
        ],
        "order": {
          "object": "ORDER",
          "id": "00000000-0000-4000-8000-000000000000",
          "identifier": "Order #2",
          "number": 100,
          "title": "Order #100",
          "status": "GHOST",
          "order_status": "OPEN",
          "is_ghost": true,
          "fulfilled_at": "2021-06-30T20:30:00Z",
          "fulfillment_status": "FULFILLED",
          "payment_status": "PAID",
          "internal_notes": "Hey there notes!",
          "currency": "USD",
          "total_amount": 2099,
          "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order",
          "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status",
          "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download",
          "downloads_allowed": true,
          "payments_allowed": true,
          "address": { … },
          "customer": { … },
          "customer_group": { … },
          "listing": { … },
          "order_form": { … },
          "discounts": [ … ],
          "tags": [ … ],
          "items": [ … ],
          "custom_items": [ … ],
          "appointments": [ … ],
          "unconfirmed_appointments": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "updated_at": "2021-06-30T20:30:00Z",
          "custom_fields": [ … ],
          "taxes": [ … ],
          "booking_limits": { … },
          "filter_by_square_feet": true,
          "filter_by_list_price": true,
          "scheduling_assignment_strategy": "RECOMMENDED",
          "balance_amount": 2099,
          "total_tax_amount": 2099,
          "total_discount_amount": 2099,
          "payments": [ … ]
        },
        "product": {
          "object": "PRODUCT",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "House photos",
          "description": "Capture photos of a house for sale.",
          "active": true,
          "type": "MAIN",
          "is_twilight": true,
          "image_url": "https://picsum.photos/400/200",
          "is_serviceable": true,
          "requires_separate_booking": true,
          "always_display_addons": true,
          "variant_filter_type": "ALL",
          "avalara_tax_code": "12345",
          "limit_quantity_amount": 10,
          "limit_quantity": true,
          "is_filterable": true,
          "is_esoft_adjustment": true,
          "variants": [ … ],
          "categories": [ … ],
          "tags": [ … ]
        },
        "product_variant": {
          "object": "PRODUCT_VARIANT",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "House photos",
          "price": 10000,
          "price_amount": 10000,
          "base_price_amount": 10000,
          "base_is_hidden": true,
          "display_original_price": true,
          "duration": 60
        },
        "taxes": [
          { … }
        ],
        "is_serviceable": true,
        "tasks": [
          { … }
        ],
        "is_canceled": true
      }
    ],
    "can_cancel": true,
    "can_reschedule": true,
    "is_within_cancellation_lock_period": true,
    "is_within_rescheduling_lock_period": true,
    "deleted_at": "2021-06-30T20:30:00Z",
    "requires_confirmation": true,
    "late_cancellation_fee": [
      {}
    ],
    "updated_at": "2021-06-30T20:30:00Z",
    "company_team_members": [
      {
        "object": "COMPANY_TEAM_MEMBER",
        "id": "00000000-0000-4000-8000-000000000000",
        "calendar_color": "#FF0000",
        "permissions": [
          { … }
        ],
        "restrictions": [
          {}
        ],
        "is_service_provider": true,
        "external_id": "1234567890",
        "company_user": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true
        }
      }
    ],
    "appointment_attendances": [
      {
        "object": "APPOINTMENT_ATTENDANCE",
        "id": 1234567890,
        "company_team_member": {
          "object": "COMPANY_TEAM_MEMBER",
          "id": "00000000-0000-4000-8000-000000000000",
          "calendar_color": "#FF0000",
          "permissions": [ … ],
          "restrictions": [ … ],
          "is_service_provider": true,
          "external_id": "1234567890",
          "company_user": { … }
        },
        "zillow_3d_home_deep_link_url": "https://aryeo.com",
        "is_requested": true,
        "accepted_at": "2021-06-30T20:30:00Z",
        "declined_at": "2021-06-30T20:30:00Z"
      }
    ]
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Update appointment.

Request

Update appointment.

external: true
Path
appointment_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an appointment.

Example: 00000000-0000-4000-8000-000000000000
Bodyapplication/json
start_atstring or null(date-time)= 20 characters

The new date and time (ISO 8601 format) when the appointment is set to start.

Example: "2021-06-30T20:30:00Z"
end_atstring or null(date-time)= 20 characters

The new date and time (ISO 8601 format) when the appointment is set to end.

Example: "2021-06-30T21:30:00Z"
user_idsArray of strings(uuid)

Array of user IDs to attach to the appointment.

Example: ["00000000-0000-4000-8000-000000000000"]
item_idsArray of strings(uuid)

Array of order item IDs to attach to the appointment.

Example: ["00000000-0000-4000-8000-000000000000"]
notifyboolean or null

Sends a notification to the appointment's order's customer that the appointment was canceled.

Example: true
const appointmentId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/${appointmentId}`,
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      start_at: '2021-06-30T20:30:00Z',
      end_at: '2021-06-30T21:30:00Z',
      user_ids: [
        '00000000-0000-4000-8000-000000000000'
      ],
      item_ids: [
        '00000000-0000-4000-8000-000000000000'
      ],
      notify: true
    })
  }
);

const data = await resp.json();
console.log(data);

Responses

AppointmentResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Appointment)

An appointment.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "status": "SCHEDULED",
    "title": "Appointment title",
    "description": "Customer: John Doe\nOrder Details: Order #123",
    "start_at": "2021-06-30T20:30:00Z",
    "end_at": "2021-06-30T20:30:00Z",
    "rescheduled_at": "2021-06-30T20:30:00Z",
    "postponed_at": "2021-06-30T20:30:00Z",
    "previous_start_at": "2021-06-30T20:30:00Z",
    "preference_type": "TIME",
    "preferred_start_at": "2021-06-30T20:30:00Z",
    "preferred_start_at_day": "2021-06-30",
    "preferred_start_at_time_of_day": "AFTERNOON",
    "duration": 60,
    "user_has_appointments_manage_permission": true,
    "order": {
      "object": "ORDER",
      "id": "00000000-0000-4000-8000-000000000000",
      "identifier": "Order #2",
      "number": 100,
      "title": "Order #100",
      "status": "GHOST",
      "order_status": "OPEN",
      "is_ghost": true,
      "fulfilled_at": "2021-06-30T20:30:00Z",
      "fulfillment_status": "FULFILLED",
      "payment_status": "PAID",
      "internal_notes": "Hey there notes!",
      "currency": "USD",
      "total_amount": 2099,
      "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order",
      "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status",
      "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download",
      "downloads_allowed": true,
      "payments_allowed": true,
      "address": {
        "id": "00000000-0000-4000-8000-000000000000",
        "latitude": 42.35157458574123,
        "longitude": -71.05763741484657,
        "street_number": "107",
        "street_name": "South St",
        "unit_number": "Unit 2F",
        "postal_code": "02111",
        "city": "Boston",
        "city_region": "Leather District",
        "county_or_parish": "Suffolk County",
        "state_or_province": "MA",
        "state_or_province_region": "Cape Cod",
        "country": "US",
        "country_region": "Napa Valley",
        "timezone": "America/New_York",
        "unparsed_address": "107 South St, Boston MA, 02111",
        "unparsed_address_part_one": "107 South St, Unit 2F",
        "unparsed_address_part_two": "Boston, MA 02111",
        "is_map_dirty": true
      },
      "customer": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": "{}",
          "owner": {},
          "company": {}
        },
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          { … }
        ],
        "owner": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_visible": true,
        "order_index": 1
      },
      "customer_group": {
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "John Doe Customer Group",
        "affiliate_id": "JOHN_DOE",
        "billing_customer": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        }
      },
      "listing": {
        "object": "LISTING",
        "id": "00000000-0000-4000-8000-000000000000",
        "address": {
          "id": "00000000-0000-4000-8000-000000000000",
          "latitude": 42.35157458574123,
          "longitude": -71.05763741484657,
          "street_number": "107",
          "street_name": "South St",
          "unit_number": "Unit 2F",
          "postal_code": "02111",
          "city": "Boston",
          "city_region": "Leather District",
          "county_or_parish": "Suffolk County",
          "state_or_province": "MA",
          "state_or_province_region": "Cape Cod",
          "country": "US",
          "country_region": "Napa Valley",
          "timezone": "America/New_York",
          "unparsed_address": "107 South St, Boston MA, 02111",
          "unparsed_address_part_one": "107 South St, Unit 2F",
          "unparsed_address_part_two": "Boston, MA 02111",
          "is_map_dirty": true
        },
        "mls_number": "1850209",
        "type": "RESIDENTIAL",
        "sub_type": "SINGLE_FAMILY_RESIDENCE",
        "status": "COMING_SOON",
        "standard_status": "COMING_SOON",
        "thumbnail_url": "https://picsum.photos/640/480",
        "large_thumbnail_url": "https://picsum.photos/1280/960",
        "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.",
        "lot": {
          "size_acres": 0.47,
          "open_parking_spaces": 3
        },
        "building": {
          "bedrooms": 4,
          "bathrooms": 3.5,
          "square_feet": 2511,
          "year_built": 1960,
          "bedrooms_number": 4
        },
        "price": {
          "list_price": 250000,
          "list_price_formatted": "$250,000"
        },
        "list_agent": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "co_list_agent": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "customer_team_memberships": [
          { … }
        ],
        "images": [
          { … }
        ],
        "videos": [
          { … }
        ],
        "floor_plans": [
          { … }
        ],
        "interactive_content": [
          { … }
        ],
        "property_website": {
          "id": "00000000-0000-4000-8000-000000000000",
          "branded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/branded",
          "unbranded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/unbranded"
        },
        "marketing_materials": [
          { … }
        ],
        "orders": [
          {}
        ],
        "appointments": [
          {}
        ],
        "unconfirmed_appointments": [
          {}
        ],
        "downloads_enabled": true,
        "is_showcase": true,
        "is_showcasable": true,
        "has_high_resolution_images": true,
        "has_zillow_imx_tour": true,
        "delivery_status": "DELIVERED"
      },
      "order_form": {
        "object": "ORDER_FORM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "BQ's Photography Order Form",
        "type": "ARYEO",
        "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
        "is_public": true,
        "thumbnail_url": "https://picsum.photos/300",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "require_upfront_payment": true,
        "upfront_payment_percentage": 50,
        "use_instant_appointment_scheduling": true,
        "form_settings": "{}",
        "owner": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "company": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        }
      },
      "discounts": [
        {
          "object": "DISCOUNT",
          "id": "00000000-0000-4000-8000-000000000000",
          "total_discount_amount": 1000,
          "coupon": { … }
        }
      ],
      "tags": [
        {
          "object": "APP\\TAGS\\MODELS\\TAG",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "Photography",
          "slug": "photography",
          "color": "#8BC34A",
          "font_color": "#FFFFFF"
        }
      ],
      "items": [
        {
          "object": "ORDER_ITEM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Aerial Video",
          "subtitle": "10 minute video",
          "sub_title": "10 minute video",
          "description": "A fly-by drone video of the property.",
          "purchasable_type": "FEE",
          "amount": 2099,
          "unit_price_amount": 2099,
          "quantity": 2,
          "gross_total_amount": 4198,
          "appointment": {},
          "discounts": [ … ],
          "order": {},
          "product": { … },
          "product_variant": { … },
          "taxes": [ … ],
          "is_serviceable": true,
          "tasks": [ … ],
          "is_canceled": true
        }
      ],
      "custom_items": [
        {
          "object": "ORDER_ITEM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Aerial Video",
          "subtitle": "10 minute video",
          "sub_title": "10 minute video",
          "description": "A fly-by drone video of the property.",
          "purchasable_type": "FEE",
          "amount": 2099,
          "unit_price_amount": 2099,
          "quantity": 2,
          "gross_total_amount": 4198,
          "appointment": {},
          "discounts": [ … ],
          "order": {},
          "product": { … },
          "product_variant": { … },
          "taxes": [ … ],
          "is_serviceable": true,
          "tasks": [ … ],
          "is_canceled": true
        }
      ],
      "appointments": [
        {}
      ],
      "unconfirmed_appointments": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "updated_at": "2021-06-30T20:30:00Z",
      "custom_fields": [
        {}
      ],
      "taxes": [
        {
          "object": "TAX",
          "id": "00000000-0000-4000-8000-000000000000",
          "total_tax_amount": 2099,
          "applied_rate": 0.075,
          "tax_rate": { … }
        }
      ],
      "booking_limits": {
        "object": "COMPANY",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "is_twilight_visible": true
      },
      "filter_by_square_feet": true,
      "filter_by_list_price": true,
      "scheduling_assignment_strategy": "RECOMMENDED",
      "balance_amount": 2099,
      "total_tax_amount": 2099,
      "total_discount_amount": 2099,
      "payments": [
        {
          "object": "ORDER_PAYMENT",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "MANUAL",
          "collection_source": "CASH",
          "completed_at": "2021-06-30T20:30:00Z",
          "applicable_amount": 502,
          "tip_amount": 100,
          "total_amount": 502,
          "collected_amount": 502,
          "order": {}
        }
      ]
    },
    "users": [
      {
        "object": "PERSONAL_ACCESS_TOKEN",
        "id": "00000000-0000-4000-8000-000000000000",
        "email": "john.doe@gmail.com",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "internal_notes": "Internal notes for the user.",
        "status": "active",
        "phone": "123456789",
        "avatar_url": "https://picsum.photos/300",
        "relationship": "owner",
        "sso_users": [
          { … }
        ],
        "is_super": true
      }
    ],
    "items": [
      {
        "object": "ORDER_ITEM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "Aerial Video",
        "subtitle": "10 minute video",
        "sub_title": "10 minute video",
        "description": "A fly-by drone video of the property.",
        "purchasable_type": "FEE",
        "amount": 2099,
        "unit_price_amount": 2099,
        "quantity": 2,
        "gross_total_amount": 4198,
        "appointment": {},
        "discounts": [
          { … }
        ],
        "order": {
          "object": "ORDER",
          "id": "00000000-0000-4000-8000-000000000000",
          "identifier": "Order #2",
          "number": 100,
          "title": "Order #100",
          "status": "GHOST",
          "order_status": "OPEN",
          "is_ghost": true,
          "fulfilled_at": "2021-06-30T20:30:00Z",
          "fulfillment_status": "FULFILLED",
          "payment_status": "PAID",
          "internal_notes": "Hey there notes!",
          "currency": "USD",
          "total_amount": 2099,
          "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order",
          "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status",
          "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download",
          "downloads_allowed": true,
          "payments_allowed": true,
          "address": { … },
          "customer": { … },
          "customer_group": { … },
          "listing": { … },
          "order_form": { … },
          "discounts": [ … ],
          "tags": [ … ],
          "items": [ … ],
          "custom_items": [ … ],
          "appointments": [ … ],
          "unconfirmed_appointments": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "updated_at": "2021-06-30T20:30:00Z",
          "custom_fields": [ … ],
          "taxes": [ … ],
          "booking_limits": { … },
          "filter_by_square_feet": true,
          "filter_by_list_price": true,
          "scheduling_assignment_strategy": "RECOMMENDED",
          "balance_amount": 2099,
          "total_tax_amount": 2099,
          "total_discount_amount": 2099,
          "payments": [ … ]
        },
        "product": {
          "object": "PRODUCT",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "House photos",
          "description": "Capture photos of a house for sale.",
          "active": true,
          "type": "MAIN",
          "is_twilight": true,
          "image_url": "https://picsum.photos/400/200",
          "is_serviceable": true,
          "requires_separate_booking": true,
          "always_display_addons": true,
          "variant_filter_type": "ALL",
          "avalara_tax_code": "12345",
          "limit_quantity_amount": 10,
          "limit_quantity": true,
          "is_filterable": true,
          "is_esoft_adjustment": true,
          "variants": [ … ],
          "categories": [ … ],
          "tags": [ … ]
        },
        "product_variant": {
          "object": "PRODUCT_VARIANT",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "House photos",
          "price": 10000,
          "price_amount": 10000,
          "base_price_amount": 10000,
          "base_is_hidden": true,
          "display_original_price": true,
          "duration": 60
        },
        "taxes": [
          { … }
        ],
        "is_serviceable": true,
        "tasks": [
          { … }
        ],
        "is_canceled": true
      }
    ],
    "can_cancel": true,
    "can_reschedule": true,
    "is_within_cancellation_lock_period": true,
    "is_within_rescheduling_lock_period": true,
    "deleted_at": "2021-06-30T20:30:00Z",
    "requires_confirmation": true,
    "late_cancellation_fee": [
      {}
    ],
    "updated_at": "2021-06-30T20:30:00Z",
    "company_team_members": [
      {
        "object": "COMPANY_TEAM_MEMBER",
        "id": "00000000-0000-4000-8000-000000000000",
        "calendar_color": "#FF0000",
        "permissions": [
          { … }
        ],
        "restrictions": [
          {}
        ],
        "is_service_provider": true,
        "external_id": "1234567890",
        "company_user": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true
        }
      }
    ],
    "appointment_attendances": [
      {
        "object": "APPOINTMENT_ATTENDANCE",
        "id": 1234567890,
        "company_team_member": {
          "object": "COMPANY_TEAM_MEMBER",
          "id": "00000000-0000-4000-8000-000000000000",
          "calendar_color": "#FF0000",
          "permissions": [ … ],
          "restrictions": [ … ],
          "is_service_provider": true,
          "external_id": "1234567890",
          "company_user": { … }
        },
        "zillow_3d_home_deep_link_url": "https://aryeo.com",
        "is_requested": true,
        "accepted_at": "2021-06-30T20:30:00Z",
        "declined_at": "2021-06-30T20:30:00Z"
      }
    ]
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Cancel appointment.

Request

Cancel appointment. The appointments order's customer can be optionally notified of this change.

external: true
Path
appointment_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an appointment. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
Bodyapplication/json
notifyboolean or null

Sends a notification to the appointment's order's customer that the appointment was canceled.

Example: true
const appointmentId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/${appointmentId}/cancel`,
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({notify: true})
  }
);

const data = await resp.json();
console.log(data);

Responses

AppointmentResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Appointment)

An appointment.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "status": "SCHEDULED",
    "title": "Appointment title",
    "description": "Customer: John Doe\nOrder Details: Order #123",
    "start_at": "2021-06-30T20:30:00Z",
    "end_at": "2021-06-30T20:30:00Z",
    "rescheduled_at": "2021-06-30T20:30:00Z",
    "postponed_at": "2021-06-30T20:30:00Z",
    "previous_start_at": "2021-06-30T20:30:00Z",
    "preference_type": "TIME",
    "preferred_start_at": "2021-06-30T20:30:00Z",
    "preferred_start_at_day": "2021-06-30",
    "preferred_start_at_time_of_day": "AFTERNOON",
    "duration": 60,
    "user_has_appointments_manage_permission": true,
    "order": {
      "object": "ORDER",
      "id": "00000000-0000-4000-8000-000000000000",
      "identifier": "Order #2",
      "number": 100,
      "title": "Order #100",
      "status": "GHOST",
      "order_status": "OPEN",
      "is_ghost": true,
      "fulfilled_at": "2021-06-30T20:30:00Z",
      "fulfillment_status": "FULFILLED",
      "payment_status": "PAID",
      "internal_notes": "Hey there notes!",
      "currency": "USD",
      "total_amount": 2099,
      "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order",
      "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status",
      "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download",
      "downloads_allowed": true,
      "payments_allowed": true,
      "address": {
        "id": "00000000-0000-4000-8000-000000000000",
        "latitude": 42.35157458574123,
        "longitude": -71.05763741484657,
        "street_number": "107",
        "street_name": "South St",
        "unit_number": "Unit 2F",
        "postal_code": "02111",
        "city": "Boston",
        "city_region": "Leather District",
        "county_or_parish": "Suffolk County",
        "state_or_province": "MA",
        "state_or_province_region": "Cape Cod",
        "country": "US",
        "country_region": "Napa Valley",
        "timezone": "America/New_York",
        "unparsed_address": "107 South St, Boston MA, 02111",
        "unparsed_address_part_one": "107 South St, Unit 2F",
        "unparsed_address_part_two": "Boston, MA 02111",
        "is_map_dirty": true
      },
      "customer": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": "{}",
          "owner": {},
          "company": {}
        },
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          { … }
        ],
        "owner": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_visible": true,
        "order_index": 1
      },
      "customer_group": {
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "John Doe Customer Group",
        "affiliate_id": "JOHN_DOE",
        "billing_customer": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        }
      },
      "listing": {
        "object": "LISTING",
        "id": "00000000-0000-4000-8000-000000000000",
        "address": {
          "id": "00000000-0000-4000-8000-000000000000",
          "latitude": 42.35157458574123,
          "longitude": -71.05763741484657,
          "street_number": "107",
          "street_name": "South St",
          "unit_number": "Unit 2F",
          "postal_code": "02111",
          "city": "Boston",
          "city_region": "Leather District",
          "county_or_parish": "Suffolk County",
          "state_or_province": "MA",
          "state_or_province_region": "Cape Cod",
          "country": "US",
          "country_region": "Napa Valley",
          "timezone": "America/New_York",
          "unparsed_address": "107 South St, Boston MA, 02111",
          "unparsed_address_part_one": "107 South St, Unit 2F",
          "unparsed_address_part_two": "Boston, MA 02111",
          "is_map_dirty": true
        },
        "mls_number": "1850209",
        "type": "RESIDENTIAL",
        "sub_type": "SINGLE_FAMILY_RESIDENCE",
        "status": "COMING_SOON",
        "standard_status": "COMING_SOON",
        "thumbnail_url": "https://picsum.photos/640/480",
        "large_thumbnail_url": "https://picsum.photos/1280/960",
        "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.",
        "lot": {
          "size_acres": 0.47,
          "open_parking_spaces": 3
        },
        "building": {
          "bedrooms": 4,
          "bathrooms": 3.5,
          "square_feet": 2511,
          "year_built": 1960,
          "bedrooms_number": 4
        },
        "price": {
          "list_price": 250000,
          "list_price_formatted": "$250,000"
        },
        "list_agent": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "co_list_agent": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "customer_team_memberships": [
          { … }
        ],
        "images": [
          { … }
        ],
        "videos": [
          { … }
        ],
        "floor_plans": [
          { … }
        ],
        "interactive_content": [
          { … }
        ],
        "property_website": {
          "id": "00000000-0000-4000-8000-000000000000",
          "branded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/branded",
          "unbranded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/unbranded"
        },
        "marketing_materials": [
          { … }
        ],
        "orders": [
          {}
        ],
        "appointments": [
          {}
        ],
        "unconfirmed_appointments": [
          {}
        ],
        "downloads_enabled": true,
        "is_showcase": true,
        "is_showcasable": true,
        "has_high_resolution_images": true,
        "has_zillow_imx_tour": true,
        "delivery_status": "DELIVERED"
      },
      "order_form": {
        "object": "ORDER_FORM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "BQ's Photography Order Form",
        "type": "ARYEO",
        "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
        "is_public": true,
        "thumbnail_url": "https://picsum.photos/300",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "require_upfront_payment": true,
        "upfront_payment_percentage": 50,
        "use_instant_appointment_scheduling": true,
        "form_settings": "{}",
        "owner": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "company": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        }
      },
      "discounts": [
        {
          "object": "DISCOUNT",
          "id": "00000000-0000-4000-8000-000000000000",
          "total_discount_amount": 1000,
          "coupon": { … }
        }
      ],
      "tags": [
        {
          "object": "APP\\TAGS\\MODELS\\TAG",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "Photography",
          "slug": "photography",
          "color": "#8BC34A",
          "font_color": "#FFFFFF"
        }
      ],
      "items": [
        {
          "object": "ORDER_ITEM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Aerial Video",
          "subtitle": "10 minute video",
          "sub_title": "10 minute video",
          "description": "A fly-by drone video of the property.",
          "purchasable_type": "FEE",
          "amount": 2099,
          "unit_price_amount": 2099,
          "quantity": 2,
          "gross_total_amount": 4198,
          "appointment": {},
          "discounts": [ … ],
          "order": {},
          "product": { … },
          "product_variant": { … },
          "taxes": [ … ],
          "is_serviceable": true,
          "tasks": [ … ],
          "is_canceled": true
        }
      ],
      "custom_items": [
        {
          "object": "ORDER_ITEM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Aerial Video",
          "subtitle": "10 minute video",
          "sub_title": "10 minute video",
          "description": "A fly-by drone video of the property.",
          "purchasable_type": "FEE",
          "amount": 2099,
          "unit_price_amount": 2099,
          "quantity": 2,
          "gross_total_amount": 4198,
          "appointment": {},
          "discounts": [ … ],
          "order": {},
          "product": { … },
          "product_variant": { … },
          "taxes": [ … ],
          "is_serviceable": true,
          "tasks": [ … ],
          "is_canceled": true
        }
      ],
      "appointments": [
        {}
      ],
      "unconfirmed_appointments": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "updated_at": "2021-06-30T20:30:00Z",
      "custom_fields": [
        {}
      ],
      "taxes": [
        {
          "object": "TAX",
          "id": "00000000-0000-4000-8000-000000000000",
          "total_tax_amount": 2099,
          "applied_rate": 0.075,
          "tax_rate": { … }
        }
      ],
      "booking_limits": {
        "object": "COMPANY",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "is_twilight_visible": true
      },
      "filter_by_square_feet": true,
      "filter_by_list_price": true,
      "scheduling_assignment_strategy": "RECOMMENDED",
      "balance_amount": 2099,
      "total_tax_amount": 2099,
      "total_discount_amount": 2099,
      "payments": [
        {
          "object": "ORDER_PAYMENT",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "MANUAL",
          "collection_source": "CASH",
          "completed_at": "2021-06-30T20:30:00Z",
          "applicable_amount": 502,
          "tip_amount": 100,
          "total_amount": 502,
          "collected_amount": 502,
          "order": {}
        }
      ]
    },
    "users": [
      {
        "object": "PERSONAL_ACCESS_TOKEN",
        "id": "00000000-0000-4000-8000-000000000000",
        "email": "john.doe@gmail.com",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "internal_notes": "Internal notes for the user.",
        "status": "active",
        "phone": "123456789",
        "avatar_url": "https://picsum.photos/300",
        "relationship": "owner",
        "sso_users": [
          { … }
        ],
        "is_super": true
      }
    ],
    "items": [
      {
        "object": "ORDER_ITEM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "Aerial Video",
        "subtitle": "10 minute video",
        "sub_title": "10 minute video",
        "description": "A fly-by drone video of the property.",
        "purchasable_type": "FEE",
        "amount": 2099,
        "unit_price_amount": 2099,
        "quantity": 2,
        "gross_total_amount": 4198,
        "appointment": {},
        "discounts": [
          { … }
        ],
        "order": {
          "object": "ORDER",
          "id": "00000000-0000-4000-8000-000000000000",
          "identifier": "Order #2",
          "number": 100,
          "title": "Order #100",
          "status": "GHOST",
          "order_status": "OPEN",
          "is_ghost": true,
          "fulfilled_at": "2021-06-30T20:30:00Z",
          "fulfillment_status": "FULFILLED",
          "payment_status": "PAID",
          "internal_notes": "Hey there notes!",
          "currency": "USD",
          "total_amount": 2099,
          "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order",
          "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status",
          "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download",
          "downloads_allowed": true,
          "payments_allowed": true,
          "address": { … },
          "customer": { … },
          "customer_group": { … },
          "listing": { … },
          "order_form": { … },
          "discounts": [ … ],
          "tags": [ … ],
          "items": [ … ],
          "custom_items": [ … ],
          "appointments": [ … ],
          "unconfirmed_appointments": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "updated_at": "2021-06-30T20:30:00Z",
          "custom_fields": [ … ],
          "taxes": [ … ],
          "booking_limits": { … },
          "filter_by_square_feet": true,
          "filter_by_list_price": true,
          "scheduling_assignment_strategy": "RECOMMENDED",
          "balance_amount": 2099,
          "total_tax_amount": 2099,
          "total_discount_amount": 2099,
          "payments": [ … ]
        },
        "product": {
          "object": "PRODUCT",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "House photos",
          "description": "Capture photos of a house for sale.",
          "active": true,
          "type": "MAIN",
          "is_twilight": true,
          "image_url": "https://picsum.photos/400/200",
          "is_serviceable": true,
          "requires_separate_booking": true,
          "always_display_addons": true,
          "variant_filter_type": "ALL",
          "avalara_tax_code": "12345",
          "limit_quantity_amount": 10,
          "limit_quantity": true,
          "is_filterable": true,
          "is_esoft_adjustment": true,
          "variants": [ … ],
          "categories": [ … ],
          "tags": [ … ]
        },
        "product_variant": {
          "object": "PRODUCT_VARIANT",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "House photos",
          "price": 10000,
          "price_amount": 10000,
          "base_price_amount": 10000,
          "base_is_hidden": true,
          "display_original_price": true,
          "duration": 60
        },
        "taxes": [
          { … }
        ],
        "is_serviceable": true,
        "tasks": [
          { … }
        ],
        "is_canceled": true
      }
    ],
    "can_cancel": true,
    "can_reschedule": true,
    "is_within_cancellation_lock_period": true,
    "is_within_rescheduling_lock_period": true,
    "deleted_at": "2021-06-30T20:30:00Z",
    "requires_confirmation": true,
    "late_cancellation_fee": [
      {}
    ],
    "updated_at": "2021-06-30T20:30:00Z",
    "company_team_members": [
      {
        "object": "COMPANY_TEAM_MEMBER",
        "id": "00000000-0000-4000-8000-000000000000",
        "calendar_color": "#FF0000",
        "permissions": [
          { … }
        ],
        "restrictions": [
          {}
        ],
        "is_service_provider": true,
        "external_id": "1234567890",
        "company_user": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true
        }
      }
    ],
    "appointment_attendances": [
      {
        "object": "APPOINTMENT_ATTENDANCE",
        "id": 1234567890,
        "company_team_member": {
          "object": "COMPANY_TEAM_MEMBER",
          "id": "00000000-0000-4000-8000-000000000000",
          "calendar_color": "#FF0000",
          "permissions": [ … ],
          "restrictions": [ … ],
          "is_service_provider": true,
          "external_id": "1234567890",
          "company_user": { … }
        },
        "zillow_3d_home_deep_link_url": "https://aryeo.com",
        "is_requested": true,
        "accepted_at": "2021-06-30T20:30:00Z",
        "declined_at": "2021-06-30T20:30:00Z"
      }
    ]
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Postpone appointment.

Request

Postpone appointment.

undocumented: true
external: true
Path
appointment_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an appointment. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const appointmentId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/${appointmentId}/postpone`,
  {
    method: 'PUT',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Reschedule appointment.

Request

Reschedule appointment. The appointments order's customer can be optionally notified of this change.

external: true
Path
appointment_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an appointment. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
Bodyapplication/json
start_atstring or null(date-time)= 20 charactersrequired

The new date and time (ISO 8601 format) when the appointment is set to start.

Example: "2021-06-30T20:30:00Z"
end_atstring or null(date-time)= 20 charactersrequired

The new date and time (ISO 8601 format) when the appointment is set to end.

Example: "2021-06-30T21:30:00Z"
notifyboolean or null

Send a notification to the appointment's order's customer that the appointment was rescheduled.

Example: true
const appointmentId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/${appointmentId}/reschedule`,
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      start_at: '2021-06-30T20:30:00Z',
      end_at: '2021-06-30T21:30:00Z',
      notify: true
    })
  }
);

const data = await resp.json();
console.log(data);

Responses

AppointmentResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Appointment)

An appointment.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": {
    "id": "00000000-0000-4000-8000-000000000000",
    "status": "SCHEDULED",
    "title": "Appointment title",
    "description": "Customer: John Doe\nOrder Details: Order #123",
    "start_at": "2021-06-30T20:30:00Z",
    "end_at": "2021-06-30T20:30:00Z",
    "rescheduled_at": "2021-06-30T20:30:00Z",
    "postponed_at": "2021-06-30T20:30:00Z",
    "previous_start_at": "2021-06-30T20:30:00Z",
    "preference_type": "TIME",
    "preferred_start_at": "2021-06-30T20:30:00Z",
    "preferred_start_at_day": "2021-06-30",
    "preferred_start_at_time_of_day": "AFTERNOON",
    "duration": 60,
    "user_has_appointments_manage_permission": true,
    "order": {
      "object": "ORDER",
      "id": "00000000-0000-4000-8000-000000000000",
      "identifier": "Order #2",
      "number": 100,
      "title": "Order #100",
      "status": "GHOST",
      "order_status": "OPEN",
      "is_ghost": true,
      "fulfilled_at": "2021-06-30T20:30:00Z",
      "fulfillment_status": "FULFILLED",
      "payment_status": "PAID",
      "internal_notes": "Hey there notes!",
      "currency": "USD",
      "total_amount": 2099,
      "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order",
      "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status",
      "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download",
      "downloads_allowed": true,
      "payments_allowed": true,
      "address": {
        "id": "00000000-0000-4000-8000-000000000000",
        "latitude": 42.35157458574123,
        "longitude": -71.05763741484657,
        "street_number": "107",
        "street_name": "South St",
        "unit_number": "Unit 2F",
        "postal_code": "02111",
        "city": "Boston",
        "city_region": "Leather District",
        "county_or_parish": "Suffolk County",
        "state_or_province": "MA",
        "state_or_province_region": "Cape Cod",
        "country": "US",
        "country_region": "Napa Valley",
        "timezone": "America/New_York",
        "unparsed_address": "107 South St, Boston MA, 02111",
        "unparsed_address_part_one": "107 South St, Unit 2F",
        "unparsed_address_part_two": "Boston, MA 02111",
        "is_map_dirty": true
      },
      "customer": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": "{}",
          "owner": {},
          "company": {}
        },
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          { … }
        ],
        "owner": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_visible": true,
        "order_index": 1
      },
      "customer_group": {
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "John Doe Customer Group",
        "affiliate_id": "JOHN_DOE",
        "billing_customer": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        }
      },
      "listing": {
        "object": "LISTING",
        "id": "00000000-0000-4000-8000-000000000000",
        "address": {
          "id": "00000000-0000-4000-8000-000000000000",
          "latitude": 42.35157458574123,
          "longitude": -71.05763741484657,
          "street_number": "107",
          "street_name": "South St",
          "unit_number": "Unit 2F",
          "postal_code": "02111",
          "city": "Boston",
          "city_region": "Leather District",
          "county_or_parish": "Suffolk County",
          "state_or_province": "MA",
          "state_or_province_region": "Cape Cod",
          "country": "US",
          "country_region": "Napa Valley",
          "timezone": "America/New_York",
          "unparsed_address": "107 South St, Boston MA, 02111",
          "unparsed_address_part_one": "107 South St, Unit 2F",
          "unparsed_address_part_two": "Boston, MA 02111",
          "is_map_dirty": true
        },
        "mls_number": "1850209",
        "type": "RESIDENTIAL",
        "sub_type": "SINGLE_FAMILY_RESIDENCE",
        "status": "COMING_SOON",
        "standard_status": "COMING_SOON",
        "thumbnail_url": "https://picsum.photos/640/480",
        "large_thumbnail_url": "https://picsum.photos/1280/960",
        "description": "There are technically no designated parking spots; however, the driveway, on the back of the house, can easily park 3 standard-sized vehicles.",
        "lot": {
          "size_acres": 0.47,
          "open_parking_spaces": 3
        },
        "building": {
          "bedrooms": 4,
          "bathrooms": 3.5,
          "square_feet": 2511,
          "year_built": 1960,
          "bedrooms_number": 4
        },
        "price": {
          "list_price": 250000,
          "list_price_formatted": "$250,000"
        },
        "list_agent": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "co_list_agent": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "customer_team_memberships": [
          { … }
        ],
        "images": [
          { … }
        ],
        "videos": [
          { … }
        ],
        "floor_plans": [
          { … }
        ],
        "interactive_content": [
          { … }
        ],
        "property_website": {
          "id": "00000000-0000-4000-8000-000000000000",
          "branded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/branded",
          "unbranded_url": "https://www.aryeo.com/v2/1200-noble-way-flower-mound-1760/unbranded"
        },
        "marketing_materials": [
          { … }
        ],
        "orders": [
          {}
        ],
        "appointments": [
          {}
        ],
        "unconfirmed_appointments": [
          {}
        ],
        "downloads_enabled": true,
        "is_showcase": true,
        "is_showcasable": true,
        "has_high_resolution_images": true,
        "has_zillow_imx_tour": true,
        "delivery_status": "DELIVERED"
      },
      "order_form": {
        "object": "ORDER_FORM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "BQ's Photography Order Form",
        "type": "ARYEO",
        "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
        "is_public": true,
        "thumbnail_url": "https://picsum.photos/300",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "require_upfront_payment": true,
        "upfront_payment_percentage": 50,
        "use_instant_appointment_scheduling": true,
        "form_settings": "{}",
        "owner": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        },
        "company": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_visible": true,
          "order_index": 1
        }
      },
      "discounts": [
        {
          "object": "DISCOUNT",
          "id": "00000000-0000-4000-8000-000000000000",
          "total_discount_amount": 1000,
          "coupon": { … }
        }
      ],
      "tags": [
        {
          "object": "APP\\TAGS\\MODELS\\TAG",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "Photography",
          "slug": "photography",
          "color": "#8BC34A",
          "font_color": "#FFFFFF"
        }
      ],
      "items": [
        {
          "object": "ORDER_ITEM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Aerial Video",
          "subtitle": "10 minute video",
          "sub_title": "10 minute video",
          "description": "A fly-by drone video of the property.",
          "purchasable_type": "FEE",
          "amount": 2099,
          "unit_price_amount": 2099,
          "quantity": 2,
          "gross_total_amount": 4198,
          "appointment": {},
          "discounts": [ … ],
          "order": {},
          "product": { … },
          "product_variant": { … },
          "taxes": [ … ],
          "is_serviceable": true,
          "tasks": [ … ],
          "is_canceled": true
        }
      ],
      "custom_items": [
        {
          "object": "ORDER_ITEM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Aerial Video",
          "subtitle": "10 minute video",
          "sub_title": "10 minute video",
          "description": "A fly-by drone video of the property.",
          "purchasable_type": "FEE",
          "amount": 2099,
          "unit_price_amount": 2099,
          "quantity": 2,
          "gross_total_amount": 4198,
          "appointment": {},
          "discounts": [ … ],
          "order": {},
          "product": { … },
          "product_variant": { … },
          "taxes": [ … ],
          "is_serviceable": true,
          "tasks": [ … ],
          "is_canceled": true
        }
      ],
      "appointments": [
        {}
      ],
      "unconfirmed_appointments": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "updated_at": "2021-06-30T20:30:00Z",
      "custom_fields": [
        {}
      ],
      "taxes": [
        {
          "object": "TAX",
          "id": "00000000-0000-4000-8000-000000000000",
          "total_tax_amount": 2099,
          "applied_rate": 0.075,
          "tax_rate": { … }
        }
      ],
      "booking_limits": {
        "object": "COMPANY",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "is_twilight_visible": true
      },
      "filter_by_square_feet": true,
      "filter_by_list_price": true,
      "scheduling_assignment_strategy": "RECOMMENDED",
      "balance_amount": 2099,
      "total_tax_amount": 2099,
      "total_discount_amount": 2099,
      "payments": [
        {
          "object": "ORDER_PAYMENT",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "MANUAL",
          "collection_source": "CASH",
          "completed_at": "2021-06-30T20:30:00Z",
          "applicable_amount": 502,
          "tip_amount": 100,
          "total_amount": 502,
          "collected_amount": 502,
          "order": {}
        }
      ]
    },
    "users": [
      {
        "object": "PERSONAL_ACCESS_TOKEN",
        "id": "00000000-0000-4000-8000-000000000000",
        "email": "john.doe@gmail.com",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "internal_notes": "Internal notes for the user.",
        "status": "active",
        "phone": "123456789",
        "avatar_url": "https://picsum.photos/300",
        "relationship": "owner",
        "sso_users": [
          { … }
        ],
        "is_super": true
      }
    ],
    "items": [
      {
        "object": "ORDER_ITEM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "Aerial Video",
        "subtitle": "10 minute video",
        "sub_title": "10 minute video",
        "description": "A fly-by drone video of the property.",
        "purchasable_type": "FEE",
        "amount": 2099,
        "unit_price_amount": 2099,
        "quantity": 2,
        "gross_total_amount": 4198,
        "appointment": {},
        "discounts": [
          { … }
        ],
        "order": {
          "object": "ORDER",
          "id": "00000000-0000-4000-8000-000000000000",
          "identifier": "Order #2",
          "number": 100,
          "title": "Order #100",
          "status": "GHOST",
          "order_status": "OPEN",
          "is_ghost": true,
          "fulfilled_at": "2021-06-30T20:30:00Z",
          "fulfillment_status": "FULFILLED",
          "payment_status": "PAID",
          "internal_notes": "Hey there notes!",
          "currency": "USD",
          "total_amount": 2099,
          "payment_url": "https://www.aryeo.com/v2/stripe/checkout/order/00000000-0000-4000-8000-000000000000?pageType=order",
          "status_url": "https://www.aryeo.com/orders/00000000-0000-4000-8000-000000000000/status",
          "invoice_url": "https://app.aryeo.test/orders/00000000-0000-4000-8000-000000000000/invoice/download",
          "downloads_allowed": true,
          "payments_allowed": true,
          "address": { … },
          "customer": { … },
          "customer_group": { … },
          "listing": { … },
          "order_form": { … },
          "discounts": [ … ],
          "tags": [ … ],
          "items": [ … ],
          "custom_items": [ … ],
          "appointments": [ … ],
          "unconfirmed_appointments": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "updated_at": "2021-06-30T20:30:00Z",
          "custom_fields": [ … ],
          "taxes": [ … ],
          "booking_limits": { … },
          "filter_by_square_feet": true,
          "filter_by_list_price": true,
          "scheduling_assignment_strategy": "RECOMMENDED",
          "balance_amount": 2099,
          "total_tax_amount": 2099,
          "total_discount_amount": 2099,
          "payments": [ … ]
        },
        "product": {
          "object": "PRODUCT",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "House photos",
          "description": "Capture photos of a house for sale.",
          "active": true,
          "type": "MAIN",
          "is_twilight": true,
          "image_url": "https://picsum.photos/400/200",
          "is_serviceable": true,
          "requires_separate_booking": true,
          "always_display_addons": true,
          "variant_filter_type": "ALL",
          "avalara_tax_code": "12345",
          "limit_quantity_amount": 10,
          "limit_quantity": true,
          "is_filterable": true,
          "is_esoft_adjustment": true,
          "variants": [ … ],
          "categories": [ … ],
          "tags": [ … ]
        },
        "product_variant": {
          "object": "PRODUCT_VARIANT",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "House photos",
          "price": 10000,
          "price_amount": 10000,
          "base_price_amount": 10000,
          "base_is_hidden": true,
          "display_original_price": true,
          "duration": 60
        },
        "taxes": [
          { … }
        ],
        "is_serviceable": true,
        "tasks": [
          { … }
        ],
        "is_canceled": true
      }
    ],
    "can_cancel": true,
    "can_reschedule": true,
    "is_within_cancellation_lock_period": true,
    "is_within_rescheduling_lock_period": true,
    "deleted_at": "2021-06-30T20:30:00Z",
    "requires_confirmation": true,
    "late_cancellation_fee": [
      {}
    ],
    "updated_at": "2021-06-30T20:30:00Z",
    "company_team_members": [
      {
        "object": "COMPANY_TEAM_MEMBER",
        "id": "00000000-0000-4000-8000-000000000000",
        "calendar_color": "#FF0000",
        "permissions": [
          { … }
        ],
        "restrictions": [
          {}
        ],
        "is_service_provider": true,
        "external_id": "1234567890",
        "company_user": {
          "object": "PERSONAL_ACCESS_TOKEN",
          "id": "00000000-0000-4000-8000-000000000000",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "internal_notes": "Internal notes for the user.",
          "status": "active",
          "phone": "123456789",
          "avatar_url": "https://picsum.photos/300",
          "relationship": "owner",
          "sso_users": [ … ],
          "is_super": true
        }
      }
    ],
    "appointment_attendances": [
      {
        "object": "APPOINTMENT_ATTENDANCE",
        "id": 1234567890,
        "company_team_member": {
          "object": "COMPANY_TEAM_MEMBER",
          "id": "00000000-0000-4000-8000-000000000000",
          "calendar_color": "#FF0000",
          "permissions": [ … ],
          "restrictions": [ … ],
          "is_service_provider": true,
          "external_id": "1234567890",
          "company_user": { … }
        },
        "zillow_3d_home_deep_link_url": "https://aryeo.com",
        "is_requested": true,
        "accepted_at": "2021-06-30T20:30:00Z",
        "declined_at": "2021-06-30T20:30:00Z"
      }
    ]
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Accept appointment.

Request

Accept appointment.

undocumented: true
external: true
Path
appointment_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an appointment. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const appointmentId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/${appointmentId}/accept`,
  {
    method: 'PUT',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Decline appointment.

Request

Decline appointment.

undocumented: true
external: true
Path
appointment_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an appointment. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const appointmentId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/${appointmentId}/decline`,
  {
    method: 'PUT',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Schedule appointment.

Request

Schedule appointment.

undocumented: true
external: true
Path
appointment_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an appointment. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const appointmentId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/${appointmentId}/schedule`,
  {
    method: 'PUT',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Appointment availability.

Request

Appointment availability.

undocumented: true
external: true
Path
appointment_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an appointment. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const appointmentId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/${appointmentId}/availability`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Get appointment 3D Home Capture link.

Request

Get appointment 3D Home Capture link.

undocumented: true
external: true
Path
appointment_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of an appointment. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const appointmentId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/${appointmentId}/3dh-tour-link`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

Success

Bodyapplication/json
object
Response
application/json
{}

Create appointment.

Request

Create appointment.

undocumented: true
external: true
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/appointments/store`,
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

201

Bodyapplication/json
object
Response
application/json
{}

Discounts

Operations related to discounts.

Operations

Listings

Operations related to listings.

Operations

Notes

Operations related to notes.

Operations

Order Forms

Operations related to order forms.

Operations

Order Items

Operations related to order items.

Operations

Orders

Operations related to orders.

Operations

Payroll

Operations related to payroll.

Operations

Products

Operations related to products.

Operations

Scheduling

Operations related to scheduling.

Operations

Tags

Operations related to tags.

Operations

Tasks

Operations related to tasks.

Operations

Users

Operations related to users.

Operations

Videos

Operations related to videos.

Operations