Aryeo (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to company users. Companies capture media for their customers. Company users represent photographers, videographers, administrators, and other staff.

Operations

Customer Users
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to customer users. Customers receive media from companies. Customer users represent real-estate agents, assistants, listing coordinators, and brokerage members.

Operations

Discounts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to discounts. Discounts support percentage or fixed-amount discounts, and coupon codes.

Operations

Listings
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to listings. Listings are the core entity that connects properties with media services.

Operations

List listings.

Request

Lists all listings available to a group.

external: true

Security

Token

Query

includestring[ 0 .. 255 ] characters

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

Example: include=list_agent,list_agent.social_profiles,list_agent.owner,co_list_agent,co_list_agent.social_profiles,co_list_agent.owner,images,files,videos,floor_plans,interactive_content,property_website

filter[search]string[ 1 .. 255 ] characters

Return listings that have fields matching this term.

Example: filter[search]=123 Main St

filter[address]string[ 1 .. 255 ] characters

Return listings that have an address matching this term.

Example: filter[address]=123 Main St

filter[list_agent]string[ 1 .. 255 ] characters

Return listings that have a listing agent or co-listing agent matching this term.

Example: filter[list_agent]=John Doe

filter[status]string[ 1 .. 100 ] characters

Return listings that have a certain status.

Enum"DRAFT""COMING_SOON""FOR_LEASE""FOR_SALE""PENDING_SALE""PENDING_LEASE""FOR_RENT""SOLD""LEASED""OFF_MARKET"

Example: filter[status]=FOR_SALE

filter[active]boolean

Set as true to return listings that have an active status (e.g. active statuses include COMING_SOON, FOR_SALE, FOR_LEASE, PENDING_SALE, PENDING_LEASE, SOLD, LEASED).

Example: filter[active]=true

filter[price_gte]number

Return listings where the price field is greater than or equal to this value.

Example: filter[price_gte]=100000

filter[price_lte]number

Return listings where the price field is less than or equal to this value.

Example: filter[price_lte]=4000000

filter[square_feet_gte]number

Return listings where the square feet field is greater than or equal to this value.

Example: filter[square_feet_gte]=1000

filter[square_feet_lte]number

Return listings where the square feet field is less than or equal to this value.

Example: filter[square_feet_lte]=5000

filter[bedrooms_gte]integer

Return listings where the bedrooms field is greater than or equal to this value.

Example: filter[bedrooms_gte]=2

filter[bedrooms_lte]integer

Return listings where the bedrooms field is less than or equal to this value.

Example: filter[bedrooms_lte]=4

filter[bathrooms_gte]number

Return listings where the bathrooms field is greater than or equal to this value.

Example: filter[bathrooms_gte]=2.5

filter[bathrooms_lte]number

Return listings where the bathrooms field is less than or equal to this value.

Example: filter[bathrooms_lte]=5

filter[delivery_status]string[ 0 .. 11 ] characters

Return listings where the delivery status is equal to this value.

Enum"DELIVERED""UNDELIVERED""SCHEDULED""null"

Example: filter[delivery_status]=DELIVERED

filter[showcase]boolean

Return listings associated with a Showcase media request.

Example: filter[showcase]=true

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 -created_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/listings`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

ListingCollection

Bodyapplication/json

statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"

dataArray of objects or null(Listing)

A collection of objects.

metaobject(PaginationMeta)

Metadata about a paginated response.

linksobject(PaginationLinks)

Create listing.

Request

Create listing.

external: true

Security

Token

Bodyapplication/json

ListingPostPayload

address_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

ID of the address to associate with the listing. UUID Version 4.

Example: "00000000-0000-4000-8000-000000000000"

list_agent_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...

ID of the customer to associate as the listing agent on the listing. UUID Versio

Example: "00000000-0000-4000-8000-000000000000"

co_list_agent_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...

ID of the customer to associate as the co-listing agent on the listing. UUID Version 4.

Example: "00000000-0000-4000-8000-000000000000"

order_idsArray of strings(uuid)

IDs of the orders to associate with this listing.

Example: ["00000000-0000-4000-8000-000000000000"]

sectionsobject

Media sections to include for this listing.

const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/listings`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      address_id: '00000000-0000-4000-8000-000000000000',
      list_agent_id: '00000000-0000-4000-8000-000000000000',
      co_list_agent_id: '00000000-0000-4000-8000-000000000000',
      order_ids: [
        '00000000-0000-4000-8000-000000000000'
      ],
      sections: {
        images: true,
        videos: true,
        floor_plans: true,
        interactive_content: true
      }
    })
  }
);

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

Responses

ListingResource

Bodyapplication/json

statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"

dataobject(Listing)

A real estate listing.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"

Response

application/json

{
  "status": "success",
  "data": {
    "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": "ACTIVE",
    "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": [
        "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": [
        {
          "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": {}
        }
      ],
      "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,
        "verification_status": "verified",
        "password_expiration_days": 30,
        "timezone": "America/New_York",
        "created_at": "2021-06-30T20:30:00Z"
      },
      "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "is_brokerage_or_brokerage_agent": true,
      "avatar_url": "https://picsum.photos/300",
      "internal_notes": "Internal notes about the group.",
      "team_members": [
        {
          "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_payroll_enabled": 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": [
        "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": [
        {
          "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": {}
        }
      ],
      "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,
        "verification_status": "verified",
        "password_expiration_days": 30,
        "timezone": "America/New_York",
        "created_at": "2021-06-30T20:30:00Z"
      },
      "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "is_brokerage_or_brokerage_agent": true,
      "avatar_url": "https://picsum.photos/300",
      "internal_notes": "Internal notes about the group.",
      "team_members": [
        {
          "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_payroll_enabled": true,
      "is_visible": true,
      "order_index": 1
    },
    "customer_team_memberships": [
      {
        "object": "CUSTOMER_TEAM_MEMBERSHIP",
        "id": "00000000-0000-4000-8000-000000000000",
        "role": "admin",
        "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
        "status": "active",
        "customer_team": {
          "object": "CUSTOMER_TEAM",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John Doe Customer Group",
          "description": "John Doe Customer Team is a customer team for John Doe.",
          "internal_notes": "John Doe's customer team normally doesn't work on Fridays.",
          "logo_url": "https://picsum.photos/640/480",
          "brokerage_name": "Grimes-Mante",
          "brokerage_website": "http://www.tillman.info/aut-odio-qui-voluptatibus",
          "affiliate_id": "JOHN_DOE",
          "should_display_original_price": true,
          "should_disable_automated_payment_reminder_email": true,
          "should_lock_downloads_before_payment": true,
          "order_form_id": "00000000-0000-4000-8000-000000000000",
          "created_at": "2025-03-07T13:59:03.000000Z",
          "is_showingtimeplus_team": true,
          "billing_customer": { … },
          "billing_customer_pays_externally": true,
          "status": "active",
          "is_archived": true,
          "website": "https://www.aryeo.com",
          "is_default": true,
          "company": { … },
          "tags": [ … ]
        },
        "is_active": true,
        "is_archived": true,
        "is_deleted": true,
        "is_invited": true,
        "is_default": true,
        "created_at": "2025-04-01T05:59:59.999999Z",
        "customer_user": {
          "object": "USER",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John",
          "email": "john.doe@gmail.com",
          "avatar_url": "https://picsum.photos/300",
          "phone": "123456789",
          "logo_url": "https://picsum.photos/300",
          "timezone": "America/New_York",
          "license_number": "12345678",
          "customer_team_memberships": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "is_visible": true,
          "order_index": 1,
          "verification_status": "verified",
          "credit_balance_amount": 100,
          "total_balance_amount": 100,
          "is_showingtimeplus_user": true,
          "full_name": "John Doe",
          "first_name": "John",
          "last_name": "Doe",
          "phone_number": "1234567890",
          "profile_link": "https://picsum.photos/300",
          "internal_notes": "John Doe is a customer.",
          "agent_company_name": "John Doe Real Estate",
          "agent_license_number": "1234567890",
          "is_blocked_from_ordering": true,
          "has_restricted_photographers": true,
          "default_lock_downloads_before_payment": true,
          "default_allows_access_to_marketing_material": true,
          "avalara_customer_code": "1234567890",
          "quickbooks_customer_id": "1234567890",
          "is_super": true,
          "status": "active"
        },
        "listing_delivery_notification_enabled": true,
        "is_showingtimeplus_workspace_membership": true,
        "is_visible": true,
        "order_index": 1
      }
    ],
    "images": [
      {
        "object": "IMAGE",
        "id": "00000000-0000-4000-8000-000000000000",
        "thumbnail_url": "https://picsum.photos/250/200",
        "large_url": "https://picsum.photos/1750/1400",
        "filename": "image.jpg",
        "original_url": "https://picsum.photos/2500/2000",
        "index": 2,
        "caption": "This is the front of the house.",
        "display_in_gallery": true
      }
    ],
    "files": [
      {
        "object": "FILE",
        "id": "0197f537-84c8-7329-b833-e28cd814a1ce",
        "uuid": "0197f537-84c8-7329-b833-e28cd814a1ce",
        "filename": "f7149b39-c3bf-47a1-b023-2f2e476ed0e5",
        "file_type": "jpg",
        "description": "Aut voluptatem numquam amet. Sed nihil ex ea maiores. Et corporis doloremque fugiat aut adipisci officia est ad.",
        "display_type": "none",
        "url": "https://cdn.aryeo.com/listings/cottagewood-rd-minnetrista-35649/resized/thumbnail/thumbnail-9c436b89-5717-403c-b5fa-054275a85ce3.jpg"
      }
    ],
    "videos": [
      {
        "object": "VIDEO",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "The New Vimeo Player (You Know, For Videos)",
        "duration": 360,
        "display_type": "BRANDED",
        "source_type": "OPTIMIZED",
        "thumbnail_url": "https://picsum.photos/300",
        "playback_url": "https://player.vimeo.com/video/76979871",
        "download_url": "https://videos.aryeo.com/listings/00000000-0000-4000-8000-000000000000/00000000-0000-4000-8000-000000000000.mp4",
        "share_url": "https://www.aryeo.com/v2/00000000-0000-4000-8000-000000000000/videos/1"
      }
    ],
    "floor_plans": [
      {
        "object": "FLOORPLAN",
        "id": "00000000-0000-4000-8000-000000000000",
        "original_url": "https://picsum.photos/2500/2000",
        "large_url": "https://picsum.photos/1750/1400",
        "thumbnail_url": "https://picsum.photos/250/200",
        "title": "Downstairs floorplan",
        "index": 1
      }
    ],
    "interactive_content": [
      {
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "My Matterport",
        "display_type": "BRANDED",
        "content_type": "MATTERPORT",
        "url": "https://my.matterport.com/show/?m=HFaxPzqNFfm",
        "thumbnail_url": "https://picsum.photos/300"
      }
    ],
    "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": [
      {
        "object": "MARKETING_MATERIAL",
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "New marketing material",
        "thumbnail_url": "https://picsum.photos/250/200",
        "published_at": "2021-06-30T20:30:00Z",
        "polotno_json": {
          "width": 500,
          "height": 500
        },
        "listing_download_hash": "00000000-0000-4000-8000-000000000000",
        "json_updated_at": 1624057368000,
        "exports": [
          { … }
        ]
      }
    ],
    "esoft_order_lines": [
      {
        "object": "ESOFT_ORDER_LINE",
        "id": "00000000-0000-4000-8000-000000000000",
        "esoft_order_line_id": 6141841,
        "client_id": 701334,
        "reference": "123 Main St",
        "status": "complete",
        "esoft_product_id": 700012,
        "esoft_product_name": "Standard Photo Editing",
        "esoft_product_variant": "PH_VT",
        "quantity": 10,
        "comments": "Please add a watermark to the photos."
      }
    ],
    "orders": [
      {
        "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_payroll_enabled": true,
          "is_visible": true,
          "order_index": 1
        },
        "customer_group": {
          "object": "CUSTOMER_TEAM",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John Doe Customer Group",
          "description": "John Doe Customer Team is a customer team for John Doe.",
          "internal_notes": "John Doe's customer team normally doesn't work on Fridays.",
          "logo_url": "https://picsum.photos/640/480",
          "brokerage_name": "Grimes-Mante",
          "brokerage_website": "http://www.tillman.info/aut-odio-qui-voluptatibus",
          "affiliate_id": "JOHN_DOE",
          "should_display_original_price": true,
          "should_disable_automated_payment_reminder_email": true,
          "should_lock_downloads_before_payment": true,
          "order_form_id": "00000000-0000-4000-8000-000000000000",
          "created_at": "2025-03-07T13:59:03.000000Z",
          "is_showingtimeplus_team": true,
          "billing_customer": { … },
          "billing_customer_pays_externally": true,
          "status": "active",
          "is_archived": true,
          "website": "https://www.aryeo.com",
          "is_default": true,
          "company": { … },
          "tags": [ … ]
        },
        "listing": {},
        "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": [
          { … }
        ]
      }
    ],
    "appointments": [
      {
        "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": { … },
          "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": [ … ]
        },
        "users": [
          { … }
        ],
        "items": [
          { … }
        ],
        "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": [
          { … }
        ],
        "appointment_attendances": [
          { … }
        ]
      }
    ],
    "unconfirmed_appointments": [
      {
        "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": { … },
          "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": [ … ]
        },
        "users": [
          { … }
        ],
        "items": [
          { … }
        ],
        "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": [
          { … }
        ],
        "appointment_attendances": [
          { … }
        ]
      }
    ],
    "downloads_enabled": true,
    "is_showcase": true,
    "is_showcasable": true,
    "has_high_resolution_images": true,
    "has_zillow_imx_tour": true,
    "delivery_status": "DELIVERED"
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Get listing.

Request

Get listing.

external: true

Security

Token

Path

listing_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a listing. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000

Query

includestring[ 0 .. 255 ] characters

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

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

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

Responses

ListingResource

Bodyapplication/json

statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"

dataobject(Listing)

A real estate listing.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"

Response

application/json

{
  "status": "success",
  "data": {
    "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": "ACTIVE",
    "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": [
        "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": [
        {
          "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": {}
        }
      ],
      "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,
        "verification_status": "verified",
        "password_expiration_days": 30,
        "timezone": "America/New_York",
        "created_at": "2021-06-30T20:30:00Z"
      },
      "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "is_brokerage_or_brokerage_agent": true,
      "avatar_url": "https://picsum.photos/300",
      "internal_notes": "Internal notes about the group.",
      "team_members": [
        {
          "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_payroll_enabled": 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": [
        "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": [
        {
          "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": {}
        }
      ],
      "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,
        "verification_status": "verified",
        "password_expiration_days": 30,
        "timezone": "America/New_York",
        "created_at": "2021-06-30T20:30:00Z"
      },
      "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "is_brokerage_or_brokerage_agent": true,
      "avatar_url": "https://picsum.photos/300",
      "internal_notes": "Internal notes about the group.",
      "team_members": [
        {
          "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_payroll_enabled": true,
      "is_visible": true,
      "order_index": 1
    },
    "customer_team_memberships": [
      {
        "object": "CUSTOMER_TEAM_MEMBERSHIP",
        "id": "00000000-0000-4000-8000-000000000000",
        "role": "admin",
        "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
        "status": "active",
        "customer_team": {
          "object": "CUSTOMER_TEAM",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John Doe Customer Group",
          "description": "John Doe Customer Team is a customer team for John Doe.",
          "internal_notes": "John Doe's customer team normally doesn't work on Fridays.",
          "logo_url": "https://picsum.photos/640/480",
          "brokerage_name": "Grimes-Mante",
          "brokerage_website": "http://www.tillman.info/aut-odio-qui-voluptatibus",
          "affiliate_id": "JOHN_DOE",
          "should_display_original_price": true,
          "should_disable_automated_payment_reminder_email": true,
          "should_lock_downloads_before_payment": true,
          "order_form_id": "00000000-0000-4000-8000-000000000000",
          "created_at": "2025-03-07T13:59:03.000000Z",
          "is_showingtimeplus_team": true,
          "billing_customer": { … },
          "billing_customer_pays_externally": true,
          "status": "active",
          "is_archived": true,
          "website": "https://www.aryeo.com",
          "is_default": true,
          "company": { … },
          "tags": [ … ]
        },
        "is_active": true,
        "is_archived": true,
        "is_deleted": true,
        "is_invited": true,
        "is_default": true,
        "created_at": "2025-04-01T05:59:59.999999Z",
        "customer_user": {
          "object": "USER",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John",
          "email": "john.doe@gmail.com",
          "avatar_url": "https://picsum.photos/300",
          "phone": "123456789",
          "logo_url": "https://picsum.photos/300",
          "timezone": "America/New_York",
          "license_number": "12345678",
          "customer_team_memberships": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "is_visible": true,
          "order_index": 1,
          "verification_status": "verified",
          "credit_balance_amount": 100,
          "total_balance_amount": 100,
          "is_showingtimeplus_user": true,
          "full_name": "John Doe",
          "first_name": "John",
          "last_name": "Doe",
          "phone_number": "1234567890",
          "profile_link": "https://picsum.photos/300",
          "internal_notes": "John Doe is a customer.",
          "agent_company_name": "John Doe Real Estate",
          "agent_license_number": "1234567890",
          "is_blocked_from_ordering": true,
          "has_restricted_photographers": true,
          "default_lock_downloads_before_payment": true,
          "default_allows_access_to_marketing_material": true,
          "avalara_customer_code": "1234567890",
          "quickbooks_customer_id": "1234567890",
          "is_super": true,
          "status": "active"
        },
        "listing_delivery_notification_enabled": true,
        "is_showingtimeplus_workspace_membership": true,
        "is_visible": true,
        "order_index": 1
      }
    ],
    "images": [
      {
        "object": "IMAGE",
        "id": "00000000-0000-4000-8000-000000000000",
        "thumbnail_url": "https://picsum.photos/250/200",
        "large_url": "https://picsum.photos/1750/1400",
        "filename": "image.jpg",
        "original_url": "https://picsum.photos/2500/2000",
        "index": 2,
        "caption": "This is the front of the house.",
        "display_in_gallery": true
      }
    ],
    "files": [
      {
        "object": "FILE",
        "id": "0197f537-84c8-7329-b833-e28cd814a1ce",
        "uuid": "0197f537-84c8-7329-b833-e28cd814a1ce",
        "filename": "f7149b39-c3bf-47a1-b023-2f2e476ed0e5",
        "file_type": "jpg",
        "description": "Aut voluptatem numquam amet. Sed nihil ex ea maiores. Et corporis doloremque fugiat aut adipisci officia est ad.",
        "display_type": "none",
        "url": "https://cdn.aryeo.com/listings/cottagewood-rd-minnetrista-35649/resized/thumbnail/thumbnail-9c436b89-5717-403c-b5fa-054275a85ce3.jpg"
      }
    ],
    "videos": [
      {
        "object": "VIDEO",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "The New Vimeo Player (You Know, For Videos)",
        "duration": 360,
        "display_type": "BRANDED",
        "source_type": "OPTIMIZED",
        "thumbnail_url": "https://picsum.photos/300",
        "playback_url": "https://player.vimeo.com/video/76979871",
        "download_url": "https://videos.aryeo.com/listings/00000000-0000-4000-8000-000000000000/00000000-0000-4000-8000-000000000000.mp4",
        "share_url": "https://www.aryeo.com/v2/00000000-0000-4000-8000-000000000000/videos/1"
      }
    ],
    "floor_plans": [
      {
        "object": "FLOORPLAN",
        "id": "00000000-0000-4000-8000-000000000000",
        "original_url": "https://picsum.photos/2500/2000",
        "large_url": "https://picsum.photos/1750/1400",
        "thumbnail_url": "https://picsum.photos/250/200",
        "title": "Downstairs floorplan",
        "index": 1
      }
    ],
    "interactive_content": [
      {
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "My Matterport",
        "display_type": "BRANDED",
        "content_type": "MATTERPORT",
        "url": "https://my.matterport.com/show/?m=HFaxPzqNFfm",
        "thumbnail_url": "https://picsum.photos/300"
      }
    ],
    "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": [
      {
        "object": "MARKETING_MATERIAL",
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "New marketing material",
        "thumbnail_url": "https://picsum.photos/250/200",
        "published_at": "2021-06-30T20:30:00Z",
        "polotno_json": {
          "width": 500,
          "height": 500
        },
        "listing_download_hash": "00000000-0000-4000-8000-000000000000",
        "json_updated_at": 1624057368000,
        "exports": [
          { … }
        ]
      }
    ],
    "esoft_order_lines": [
      {
        "object": "ESOFT_ORDER_LINE",
        "id": "00000000-0000-4000-8000-000000000000",
        "esoft_order_line_id": 6141841,
        "client_id": 701334,
        "reference": "123 Main St",
        "status": "complete",
        "esoft_product_id": 700012,
        "esoft_product_name": "Standard Photo Editing",
        "esoft_product_variant": "PH_VT",
        "quantity": 10,
        "comments": "Please add a watermark to the photos."
      }
    ],
    "orders": [
      {
        "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_payroll_enabled": true,
          "is_visible": true,
          "order_index": 1
        },
        "customer_group": {
          "object": "CUSTOMER_TEAM",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John Doe Customer Group",
          "description": "John Doe Customer Team is a customer team for John Doe.",
          "internal_notes": "John Doe's customer team normally doesn't work on Fridays.",
          "logo_url": "https://picsum.photos/640/480",
          "brokerage_name": "Grimes-Mante",
          "brokerage_website": "http://www.tillman.info/aut-odio-qui-voluptatibus",
          "affiliate_id": "JOHN_DOE",
          "should_display_original_price": true,
          "should_disable_automated_payment_reminder_email": true,
          "should_lock_downloads_before_payment": true,
          "order_form_id": "00000000-0000-4000-8000-000000000000",
          "created_at": "2025-03-07T13:59:03.000000Z",
          "is_showingtimeplus_team": true,
          "billing_customer": { … },
          "billing_customer_pays_externally": true,
          "status": "active",
          "is_archived": true,
          "website": "https://www.aryeo.com",
          "is_default": true,
          "company": { … },
          "tags": [ … ]
        },
        "listing": {},
        "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": [
          { … }
        ]
      }
    ],
    "appointments": [
      {
        "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": { … },
          "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": [ … ]
        },
        "users": [
          { … }
        ],
        "items": [
          { … }
        ],
        "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": [
          { … }
        ],
        "appointment_attendances": [
          { … }
        ]
      }
    ],
    "unconfirmed_appointments": [
      {
        "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": { … },
          "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": [ … ]
        },
        "users": [
          { … }
        ],
        "items": [
          { … }
        ],
        "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": [
          { … }
        ],
        "appointment_attendances": [
          { … }
        ]
      }
    ],
    "downloads_enabled": true,
    "is_showcase": true,
    "is_showcasable": true,
    "has_high_resolution_images": true,
    "has_zillow_imx_tour": true,
    "delivery_status": "DELIVERED"
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Update listing.

Request

Update listing.

external: true

Security

Token

Path

listing_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a listing. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000

Bodyapplication/json

ListingPutPayload

titlestring or null[ 0 .. 255 ] characters

The title of the listing.

Example: "Must see apartment!"

descriptionstring or null[ 0 .. 255 ] characters

The description of the listing.

Example: "Beautiful 2 bedroom apartment in the heart of downtown"

statusstring or null[ 0 .. 255 ] characters

The status of the listing.

Example: "FOR_SALE"

mls_live_datestring or null(date)= 10 characters

The date the MLS listing will go live.

Example: "2021-06-30"

mls_numberstring or null[ 0 .. 255 ] characters

The MLS number of the listing.

Example: "170598340"

priceinteger or null

The price of the listing property.

Example: 500000

bedroomsnumber or null(float)[ 0 .. 99 ]

A decimal value representing the number of bedrooms for the listing.

Example: 1.5

bathroomsnumber or null(float)[ 0 .. 99 ]

A decimal value representing the number of bathrooms for the listing.

Example: 1.5

home_squarefootagenumber or null(float)[ 0 .. 999999 ]

A decimal value representing the square footage the listing.

Example: 4200

lot_acresnumber or null(float)[ 0 .. 9999 ]

A decimal value representing the acreage the listing.

Example: 4200

parking_spotsnumber or null(float)[ 0 .. 999 ]

A decimal value representing the number of parking spots for the listing.

Example: 2

year_builtinteger or null>= 1500

The year the house for the listing was built.

Example: 1980

property_typestring or null[ 0 .. 255 ] characters

The type of the listing.

Example: "SINGLE_FAMILY"

is_showcaseboolean or null

Indicates if this is a Showcase listing

Example: true

const listingId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/listings/${listingId}`,
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      title: 'Must see apartment!',
      description: 'Beautiful 2 bedroom apartment in the heart of downtown',
      status: 'FOR_SALE',
      mls_live_date: '2021-06-30',
      mls_number: '170598340',
      price: 500000,
      bedrooms: 1.5,
      bathrooms: 1.5,
      home_squarefootage: 4200,
      lot_acres: 4200,
      parking_spots: 2,
      year_built: 1980,
      property_type: 'SINGLE_FAMILY',
      is_showcase: true
    })
  }
);

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

Responses

ListingResource

Bodyapplication/json

statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"

dataobject(Listing)

A real estate listing.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"

Response

application/json

{
  "status": "success",
  "data": {
    "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": "ACTIVE",
    "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": [
        "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": [
        {
          "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": {}
        }
      ],
      "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,
        "verification_status": "verified",
        "password_expiration_days": 30,
        "timezone": "America/New_York",
        "created_at": "2021-06-30T20:30:00Z"
      },
      "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "is_brokerage_or_brokerage_agent": true,
      "avatar_url": "https://picsum.photos/300",
      "internal_notes": "Internal notes about the group.",
      "team_members": [
        {
          "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_payroll_enabled": 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": [
        "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": [
        {
          "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": {}
        }
      ],
      "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,
        "verification_status": "verified",
        "password_expiration_days": 30,
        "timezone": "America/New_York",
        "created_at": "2021-06-30T20:30:00Z"
      },
      "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "is_brokerage_or_brokerage_agent": true,
      "avatar_url": "https://picsum.photos/300",
      "internal_notes": "Internal notes about the group.",
      "team_members": [
        {
          "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_payroll_enabled": true,
      "is_visible": true,
      "order_index": 1
    },
    "customer_team_memberships": [
      {
        "object": "CUSTOMER_TEAM_MEMBERSHIP",
        "id": "00000000-0000-4000-8000-000000000000",
        "role": "admin",
        "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
        "status": "active",
        "customer_team": {
          "object": "CUSTOMER_TEAM",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John Doe Customer Group",
          "description": "John Doe Customer Team is a customer team for John Doe.",
          "internal_notes": "John Doe's customer team normally doesn't work on Fridays.",
          "logo_url": "https://picsum.photos/640/480",
          "brokerage_name": "Grimes-Mante",
          "brokerage_website": "http://www.tillman.info/aut-odio-qui-voluptatibus",
          "affiliate_id": "JOHN_DOE",
          "should_display_original_price": true,
          "should_disable_automated_payment_reminder_email": true,
          "should_lock_downloads_before_payment": true,
          "order_form_id": "00000000-0000-4000-8000-000000000000",
          "created_at": "2025-03-07T13:59:03.000000Z",
          "is_showingtimeplus_team": true,
          "billing_customer": { … },
          "billing_customer_pays_externally": true,
          "status": "active",
          "is_archived": true,
          "website": "https://www.aryeo.com",
          "is_default": true,
          "company": { … },
          "tags": [ … ]
        },
        "is_active": true,
        "is_archived": true,
        "is_deleted": true,
        "is_invited": true,
        "is_default": true,
        "created_at": "2025-04-01T05:59:59.999999Z",
        "customer_user": {
          "object": "USER",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John",
          "email": "john.doe@gmail.com",
          "avatar_url": "https://picsum.photos/300",
          "phone": "123456789",
          "logo_url": "https://picsum.photos/300",
          "timezone": "America/New_York",
          "license_number": "12345678",
          "customer_team_memberships": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "is_visible": true,
          "order_index": 1,
          "verification_status": "verified",
          "credit_balance_amount": 100,
          "total_balance_amount": 100,
          "is_showingtimeplus_user": true,
          "full_name": "John Doe",
          "first_name": "John",
          "last_name": "Doe",
          "phone_number": "1234567890",
          "profile_link": "https://picsum.photos/300",
          "internal_notes": "John Doe is a customer.",
          "agent_company_name": "John Doe Real Estate",
          "agent_license_number": "1234567890",
          "is_blocked_from_ordering": true,
          "has_restricted_photographers": true,
          "default_lock_downloads_before_payment": true,
          "default_allows_access_to_marketing_material": true,
          "avalara_customer_code": "1234567890",
          "quickbooks_customer_id": "1234567890",
          "is_super": true,
          "status": "active"
        },
        "listing_delivery_notification_enabled": true,
        "is_showingtimeplus_workspace_membership": true,
        "is_visible": true,
        "order_index": 1
      }
    ],
    "images": [
      {
        "object": "IMAGE",
        "id": "00000000-0000-4000-8000-000000000000",
        "thumbnail_url": "https://picsum.photos/250/200",
        "large_url": "https://picsum.photos/1750/1400",
        "filename": "image.jpg",
        "original_url": "https://picsum.photos/2500/2000",
        "index": 2,
        "caption": "This is the front of the house.",
        "display_in_gallery": true
      }
    ],
    "files": [
      {
        "object": "FILE",
        "id": "0197f537-84c8-7329-b833-e28cd814a1ce",
        "uuid": "0197f537-84c8-7329-b833-e28cd814a1ce",
        "filename": "f7149b39-c3bf-47a1-b023-2f2e476ed0e5",
        "file_type": "jpg",
        "description": "Aut voluptatem numquam amet. Sed nihil ex ea maiores. Et corporis doloremque fugiat aut adipisci officia est ad.",
        "display_type": "none",
        "url": "https://cdn.aryeo.com/listings/cottagewood-rd-minnetrista-35649/resized/thumbnail/thumbnail-9c436b89-5717-403c-b5fa-054275a85ce3.jpg"
      }
    ],
    "videos": [
      {
        "object": "VIDEO",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "The New Vimeo Player (You Know, For Videos)",
        "duration": 360,
        "display_type": "BRANDED",
        "source_type": "OPTIMIZED",
        "thumbnail_url": "https://picsum.photos/300",
        "playback_url": "https://player.vimeo.com/video/76979871",
        "download_url": "https://videos.aryeo.com/listings/00000000-0000-4000-8000-000000000000/00000000-0000-4000-8000-000000000000.mp4",
        "share_url": "https://www.aryeo.com/v2/00000000-0000-4000-8000-000000000000/videos/1"
      }
    ],
    "floor_plans": [
      {
        "object": "FLOORPLAN",
        "id": "00000000-0000-4000-8000-000000000000",
        "original_url": "https://picsum.photos/2500/2000",
        "large_url": "https://picsum.photos/1750/1400",
        "thumbnail_url": "https://picsum.photos/250/200",
        "title": "Downstairs floorplan",
        "index": 1
      }
    ],
    "interactive_content": [
      {
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "My Matterport",
        "display_type": "BRANDED",
        "content_type": "MATTERPORT",
        "url": "https://my.matterport.com/show/?m=HFaxPzqNFfm",
        "thumbnail_url": "https://picsum.photos/300"
      }
    ],
    "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": [
      {
        "object": "MARKETING_MATERIAL",
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "New marketing material",
        "thumbnail_url": "https://picsum.photos/250/200",
        "published_at": "2021-06-30T20:30:00Z",
        "polotno_json": {
          "width": 500,
          "height": 500
        },
        "listing_download_hash": "00000000-0000-4000-8000-000000000000",
        "json_updated_at": 1624057368000,
        "exports": [
          { … }
        ]
      }
    ],
    "esoft_order_lines": [
      {
        "object": "ESOFT_ORDER_LINE",
        "id": "00000000-0000-4000-8000-000000000000",
        "esoft_order_line_id": 6141841,
        "client_id": 701334,
        "reference": "123 Main St",
        "status": "complete",
        "esoft_product_id": 700012,
        "esoft_product_name": "Standard Photo Editing",
        "esoft_product_variant": "PH_VT",
        "quantity": 10,
        "comments": "Please add a watermark to the photos."
      }
    ],
    "orders": [
      {
        "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_payroll_enabled": true,
          "is_visible": true,
          "order_index": 1
        },
        "customer_group": {
          "object": "CUSTOMER_TEAM",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John Doe Customer Group",
          "description": "John Doe Customer Team is a customer team for John Doe.",
          "internal_notes": "John Doe's customer team normally doesn't work on Fridays.",
          "logo_url": "https://picsum.photos/640/480",
          "brokerage_name": "Grimes-Mante",
          "brokerage_website": "http://www.tillman.info/aut-odio-qui-voluptatibus",
          "affiliate_id": "JOHN_DOE",
          "should_display_original_price": true,
          "should_disable_automated_payment_reminder_email": true,
          "should_lock_downloads_before_payment": true,
          "order_form_id": "00000000-0000-4000-8000-000000000000",
          "created_at": "2025-03-07T13:59:03.000000Z",
          "is_showingtimeplus_team": true,
          "billing_customer": { … },
          "billing_customer_pays_externally": true,
          "status": "active",
          "is_archived": true,
          "website": "https://www.aryeo.com",
          "is_default": true,
          "company": { … },
          "tags": [ … ]
        },
        "listing": {},
        "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": [
          { … }
        ]
      }
    ],
    "appointments": [
      {
        "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": { … },
          "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": [ … ]
        },
        "users": [
          { … }
        ],
        "items": [
          { … }
        ],
        "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": [
          { … }
        ],
        "appointment_attendances": [
          { … }
        ]
      }
    ],
    "unconfirmed_appointments": [
      {
        "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": { … },
          "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": [ … ]
        },
        "users": [
          { … }
        ],
        "items": [
          { … }
        ],
        "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": [
          { … }
        ],
        "appointment_attendances": [
          { … }
        ]
      }
    ],
    "downloads_enabled": true,
    "is_showcase": true,
    "is_showcasable": true,
    "has_high_resolution_images": true,
    "has_zillow_imx_tour": true,
    "delivery_status": "DELIVERED"
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Get listing Cubicasa information.

Request

Get listing Cubicasa information.

undocumented: false

external: true

Security

Token

Path

listing_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a listing. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000

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

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

Responses

CubiCasaFloorplanResource

Bodyapplication/json

statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"

dataobject(CubiCasaFloorplan)

A Cubicasa floorplan.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"

Response

application/json

{
  "status": "success",
  "data": {
    "current_sync": "1234567890",
    "results": [
      {
        "full_address": "10 Rockefeller Plaza, New York, NY 10020",
        "city": "New York",
        "county": "United States",
        "latitude": 40.758044,
        "longitude": -73.979479,
        "number": "10",
        "postalCode": "10020",
        "state": "NY",
        "street": "Rockefeller Plaza",
        "suite": "Apt 100",
        "public_id": "d7c378b1-2b02-4f97-8624-90f2fa154d42",
        "status": "Ready",
        "jpg_urls": [
          "https://www.afakedomain.com/10-rockerfeller-plaza-new-york-ny-united-states_0.jpg"
        ]
      }
    ],
    "show_all": true,
    "suggested": {}
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Search listing details.

Request

Search listing details.

undocumented: false

external: true

Security

Token

Path

listing_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a listing. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000

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

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

Responses

ListingDetailSearchResource

Bodyapplication/json

statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"

dataobject(ListingDetailSearch)

Search results for a listing.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"

Response

application/json

{
  "status": "success",
  "data": {
    "bedrooms": 4,
    "bathrooms": 3.5,
    "square_feet": 2511,
    "year_built": 1960,
    "lot_size_acres": 0.47
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Get listing statistics.

Request

Get listing statistics.

undocumented: false

external: true

Security

Token

Path

listing_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a listing. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000

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

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

Responses

ListingStatsResource

Bodyapplication/json

main_listing_statsobject(ListingStats)required

Stats for a listing.

main_listing_stats.totalViewsstring or number or null

Total number of views.

Example: 0

main_listing_stats.totalUsersstring or number or null

Total number of users.

Example: 0

main_listing_stats.avgTimeOnPagestring or number or null

Average time on page.

Example: 0

main_listing_stats.topReferrerstring or null[ 0 .. 255 ] characters

Top referrer.

Example: "Jarrod Parkes"

main_listing_stats.allReferrersArray of strings or null

All referrers.

Example: ["Jarrod Parkes"]

Response

application/json

{
  "main_listing_stats": {
    "totalViews": 0,
    "totalUsers": 0,
    "avgTimeOnPage": 0,
    "topReferrer": "Jarrod Parkes",
    "allReferrers": [
      "Jarrod Parkes"
    ]
  }
}

Notes
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to notes. Notes are contextual comments across various entities including orders, listings, customers, and appointments.

Operations

Order Forms
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to order forms. Order forms are the customer-facing booking interfaces for service requests, product selection, and appointment scheduling.

Operations

Order Items
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to order items. Order items are the individual line items within orders.

Operations

Orders
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to orders. Orders are the service orders from customers.

Operations

Payroll
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to payroll.

Operations

Products
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to products. Products consist of the categories and offerings for services and products.

Operations

Scheduling
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to scheduling. Scheduling operations provide information about service provider availability.

Operations

Tags
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to tags. Tags are used to organize and categorize content using a flexible tagging system.

Operations

Tasks
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to tasks. Tasks are used to track work items, assignments, and completion status.

Operations

Videos
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations related to videos.

Operations

Aryeo (1.0.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Introduction

AddressesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

AppointmentsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Company UsersCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Customer UsersCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

DiscountsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ListingsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

List listings.

Request

Responses

Was this helpful?

Create listing.

RequestExpand all

Responses

Was this helpful?

Get listing.

Request

Responses

Was this helpful?

Update listing.

Request

Responses

Was this helpful?

Get listing Cubicasa information.

Request

Responses

Was this helpful?

Search listing details.

Request

Responses

Was this helpful?

Get listing statistics.

Request

Responses

Was this helpful?

NotesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Order FormsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Order ItemsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

OrdersCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PayrollCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ProductsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SchedulingCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

TagsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

TasksCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

VideosCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Aryeo (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Addresses
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Appointments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Company Users
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Customer Users
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Discounts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Listings
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request

Notes
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Order Forms
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Order Items
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Orders
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Payroll
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Products
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Scheduling
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Tags
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Tasks
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Videos
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude