> ## Documentation Index > Fetch the complete documentation index at: https://docs.windermere.com/llms.txt > Use this file to discover all available pages before exploring further. # listings > listings ## OpenAPI ````yaml /windermereapi(1).json get /listings openapi: 3.0.1 info: title: WindermereAPI description: '' version: '1.0' servers: - url: https://api.windermere.com/v1/api security: - apiKeyHeader: [] - apiKeyQuery: [] paths: /listings: get: tags: - Endpoints - Listings summary: listings description: listings operationId: listings parameters: - name: moxi_works_company_id in: query description: >- A valid MoxiWorks Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use. required: true schema: type: string - name: parent_company_id in: query description: >- This is the numeric_id or moxi_works_company_id of a company that is considered to be a parent company in the MoxiWorks Platform. This request attribute has two functions: 1. It provides for a broad scope by which partners may be afforded permissions to perform MoxiWorks Platform actions, in scenarios where a partner does business with a parent company in the MoxiWorks System. 2. It provides broad scope under which agents may be looked up using the source_agent_id request attribute in many scenarios across different MoxiWorks Platform endpoints and actions. Please note that this attribute cannot be used as a replacement for the moxi_works_company_id request attribute in scenarios where the moxi_works_company_id request attribute is required by the action. Please note that this attribute cannot be used to broaden scope of any request where the scope of the request is defined by the moxi_works_company_id request attribute. Please note that when passed in conjunction with the moxi_works_company_id request attribute, the value of moxi_works_company_id request attribute must be the numeric id form. Any use of this request attribute must be coordinated with MoxiWorks Platform Partner services. Please reach out to partner services for more information. schema: type: string - name: updated_since in: query description: >- Paged responses of all Listing objects updated after this Unix timestamp will be returned in the response. If no updated_since parameter is included in the request, only Listing objects updated in the last seven days will be returned. schema: type: integer - name: agent_uuid in: query description: >- This is the MoxiWorks Platform ID of the Agent which Listing objects are associated with. This will be an RFC 4122 compliant UUID. schema: type: string - name: moxi_works_agent_id in: query description: >- Use this parameter when searching for Listing objects associated with a specific Agent. This will be a string that may take the form of an email address, or a unique identification string. This data must reference a valid MoxiWorks Agent ID for your Listing Index request to be accepted. A company’s internal agent id may be used to construct the agent’s unique identification string. To do so, the value passed via the moxi_works_agent_id should be a single concatenated string, of the form: [moxi_works_company_id]:[internal_agent_id] Use Company Endpoint to determine which moxi_works_company_id to use. schema: type: string - name: moxi_works_office_id in: query description: >- Use this parameter when searching for Listing objects associated with a specific Office. This data must reference a valid MoxiWorks Office ID for your Listing Index request to be accepted. schema: type: string - name: last_moxi_works_listing_id in: query description: >- If fetching a multi-page response, this should be the MoxiWorksListingId found in the last Listing object of the previously fetched page. schema: type: string - name: shared_partner_data_updated_since in: query description: >- Include additional listings using this unix timestamp representing the date since partner data has been updated. This attribute should be used in conjuncion with the updated_since attribute. schema: type: integer - name: market_status in: query description: "When filtering by market_status use one of the following options:\n\nValue\tDescription\non-market\t\nThe default value for market_status. This listing set includes ‘Active,’ ‘Pending’ and ‘Contingent’ listings.\noff-market\t\nIf market_status is set to this value, only off-market listings will be returned.\nall\t\nWhen market_status is set to this value, both off-market and on-market listings will be returned." schema: type: string - name: property_types in: query description: "When filtering by property_types pass a comma separated string of integers associated with various property types.\nWhen property_types is not inlcuded, all property types will be included in the response.\n\nUse this legend to determine which integer values to include in property_types.\n\nNumber\tProperty Type\n-1\t\nNot Found\n1\t\nResidential\n2\t\nCondo\n3\t\nLand\n4\t\nMfghome\n5\t\nFarm/Ranch\n6\t\nRental\n7\t\nMultifamily\n8\t\nCo-op\n9\t\nTownhouse\n10\t\nCommerical\n11\t\nBusiness Opportunity\n12\t\nCommercial Res Income\n13\t\nCommercial Hotel\n14\t\nCommercial Mobile Home Park\n15\t\nCommercial Lease\n16\t\nCommercial Land\n17\t\nMoorage\n18\t\nTimeshare\n19\t\nCommercial Industrial\n20\t\nMultifamily2_4\n21\t\nMultifamily5up\n22\t\nApartment\n23\t\nHighrise" schema: type: string - name: only_agent_created in: query description: >- When this filter parameter is passed as true, the response will be restricted to listings created by agents (non-mls listings). schema: type: boolean - name: coming_soon in: query description: >- When this attribute is passed as true only listings with status “ComingSoon” will be returned. schema: type: boolean - name: underscore_response in: query description: >- When this attribute is passed as true, the json keys of the response will be underscored. The default json key format for listing responses is camel casing. schema: type: boolean - name: timestamps_only in: query description: >- If supplied then the results will exclude all data except primary identifiers and a unix timestamp (last_updated) & iso8601 timestamp (modification_timestamp) of the last time this record was updated. schema: type: boolean responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/Listings__OnMarket_' example: FinalPage: true Listings: - LotSizeAcres: 0 BathroomsFull: 0 BathroomsHalf: 0 BathroomsOneQuarter: {} BathroomsPartial: {} BathroomsThreeQuarter: {} BathroomsTotalInteger: 0 BathroomsTotal: 0 BedroomsTotal: 0 PublicTitle: string PublicRemarks: string ModificationTimestamp: string StatusChangeDate: string InternetAddressDisplayYN: true DaysOnMarket: 0 ListingContractDate: string CreatedDate: string ElementarySchool: string GarageSpaces: 0 WaterfrontYN: true HighSchool: string AssociationFee: {} ListOfficeName: string ListPrice: 0 ListingID: string ListAgentFullName: string ListAgentUUID: string ListAgentOfficeID: string ListAgentMoxiWorksOfficeID: string SecondaryListAgentFullName: string SecondaryListAgentUUID: string SchoolDistrict: string Address: string Address2: {} City: string CountyOrParish: string Latitude: string Longitude: string StateOrProvince: string PostalCode: string Community: string LotSizeSquareFeet: {} InternetEntireListingDisplayYN: true MiddleOrJuniorSchool: string ListOfficeAOR: string ListOfficeAORArea: string NewConstructionYN: true PoolYN: true PropertyType: string TaxAnnualAmount: 0 TaxYear: 0 SingleStory: true LivingArea: 0 ViewYN: true YearBuilt: 0 OnMarket: true Status: string MoxiWorksListingId: string AgentCreatedListing: true VirtualTourURL: string SharedPartnerData: attribute_1: string attribute_2: string TaxParcelId: string ListingURL: string PropertyFeatures: - PropertyFeatureName: string PropertyFeatureValues: - string CompanyListingAttributes: - AttributeId: string AttributeName: string OpenHouse: - Date: string StartTime: string EndTime: string VirtualOpenHouseYN: true VirtualOpenHouseURL: {} Comment: {} ImagesLastModified: string ListingImages: - FullURL: string GalleryURL: string RawURL: string SmallURL: string ThumbURL: string Title: string IsMainListingImage: true Caption: string Description: string Width: 0 Height: 0 MimeType: string BuyerCommissionType: string BuyerCommissionValue: string VendorModificationTimestamp: string components: schemas: Listings__OnMarket_: type: object properties: FinalPage: type: boolean Listings: type: array items: type: object properties: LotSizeAcres: type: integer BathroomsFull: type: integer BathroomsHalf: type: integer BathroomsOneQuarter: {} BathroomsPartial: {} BathroomsThreeQuarter: {} BathroomsTotalInteger: type: integer BathroomsTotal: type: integer BedroomsTotal: type: integer PublicTitle: type: string PublicRemarks: type: string ModificationTimestamp: type: string StatusChangeDate: type: string InternetAddressDisplayYN: type: boolean DaysOnMarket: type: integer ListingContractDate: type: string CreatedDate: type: string ElementarySchool: type: string GarageSpaces: type: integer WaterfrontYN: type: boolean HighSchool: type: string AssociationFee: {} ListOfficeName: type: string ListPrice: type: integer ListingID: type: string ListAgentFullName: type: string ListAgentUUID: type: string ListAgentOfficeID: type: string ListAgentMoxiWorksOfficeID: type: string SecondaryListAgentFullName: type: string SecondaryListAgentUUID: type: string SchoolDistrict: type: string Address: type: string Address2: {} City: type: string CountyOrParish: type: string Latitude: type: string Longitude: type: string StateOrProvince: type: string PostalCode: type: string Community: type: string LotSizeSquareFeet: {} InternetEntireListingDisplayYN: type: boolean MiddleOrJuniorSchool: type: string ListOfficeAOR: type: string ListOfficeAORArea: type: string NewConstructionYN: type: boolean PoolYN: type: boolean PropertyType: type: string TaxAnnualAmount: type: integer TaxYear: type: integer SingleStory: type: boolean LivingArea: type: integer ViewYN: type: boolean YearBuilt: type: integer OnMarket: type: boolean Status: type: string MoxiWorksListingId: type: string AgentCreatedListing: type: boolean VirtualTourURL: type: string SharedPartnerData: type: object properties: attribute_1: type: string attribute_2: type: string TaxParcelId: type: string ListingURL: type: string PropertyFeatures: type: array items: type: object properties: PropertyFeatureName: type: string PropertyFeatureValues: type: array items: type: string CompanyListingAttributes: type: array items: type: object properties: AttributeId: type: string AttributeName: type: string OpenHouse: type: array items: type: object properties: Date: type: string StartTime: type: string EndTime: type: string VirtualOpenHouseYN: type: boolean VirtualOpenHouseURL: {} Comment: {} ImagesLastModified: type: string ListingImages: type: array items: type: object properties: FullURL: type: string GalleryURL: type: string RawURL: type: string SmallURL: type: string ThumbURL: type: string Title: type: string IsMainListingImage: type: boolean Caption: type: string Description: type: string Width: type: integer Height: type: integer MimeType: type: string BuyerCommissionType: type: string BuyerCommissionValue: type: string VendorModificationTimestamp: type: string x-apim-schema-name: Listings (OnMarket) securitySchemes: apiKeyHeader: type: apiKey name: x-api-key in: header apiKeyQuery: type: apiKey name: api-key in: query ````