--- title: "Stream all sales & listings" method: GET path: "/api/files" tags: ["Bulk Export"] --- # Stream all sales & listings `GET /api/files` ### Validation & Requirements #### Required Parameters - None #### Required JSON Body Fields - None #### Validations - Invalid GUID values in `*Guid`/`*Guids` fields return `422 Unprocessable Entity`. - Invalid date values in `*date*` fields return `422 Unprocessable Entity`. - Missing required request body returns `422 Unprocessable Entity` with `Missing request body.`. - Additional business-rule validation may return `422` with details in the `errors` array. ## Query parameters - `createdAfter` string, date-time, nullable - `createdBefore` string, date-time, nullable - `modifiedAfter` string, date-time, nullable - `modifiedBefore` string, date-time, nullable - `checklistModifiedBefore` string, date-time, nullable - `checklistModifiedAfter` string, date-time, nullable - `closedAfter` string, date-time, nullable - `closedBefore` string, date-time, nullable - `email` string, nullable - `propertyAddress` string, nullable - `state` string, nullable - `zip` string, nullable - `type` string, nullable - `status` string, nullable - `stage` string, nullable - `excludeStage` string, nullable ## Response `200` Returns a JSON object with a 'value' array containing summary, listing, and sale objects. Items are streamed as they are retrieved — consumers can process each item as it arrives. - BulkExportStreamingResponse - `value` union[], nullable — Array of export objects streamed as they are retrieved. The first element is always a summary object, followed by zero or more listing and sale objects (identified by the objectType field). Items are flushed to the response individually, separated by comma+newline, so consumers can process each item as it arrives without waiting for the full response. - union - BulkExportSale - `objectType` string, nullable — The type of the object. Always 'sale' for this object. - `saleGuid` string, guid — The GUID for this sale. - `listingGuid` string, guid, nullable — The GUID for the listing that this sale was converted from. - `agentGuid` string, guid, nullable — The GUID of the primary agent. - `createdByGuid` string, guid, nullable — The GUID of the user who created this sale. - `mlsNumber` string, nullable — The MLS number. - `escrowNumber` string, nullable — The escrow number. - `statusId` integer, nullable — The status ID. - `status` string, nullable — The current status (pending, closed, archived, etc). Returns "Unknown" for status ids not yet mapped by the API. Returns Canadian terms (e.g. "Firm" instead of "Pending") when the resolved terminology locale is en-CA. - `officeId` integer, nullable — The office ID. - `officeGuid` string, guid, nullable — The office GUID. - `checklistType` string, nullable — The checklist type. - `escrowClosingDate` string, date-time, nullable — The scheduled escrow closing date. - `actualClosingDate` string, date-time, nullable — The actual closing date. - `contractAcceptedDate` string, date-time, nullable — The date the contract was accepted. - `modifiedOn` string, date-time, nullable — When this sale was last modified. - `source` string, nullable — The source of this sale. - `otherSource` string, nullable — Other source information if applicable. - `deadDate` string, date-time, nullable — The date the transaction was cancelled. Null if the transaction has not been cancelled. - `dealType` string, nullable — The side of the deal the agent represents (buyer, seller, both). - `listingPrice` number, nullable — The listing price. - `salePrice` number, nullable — The sale price. - `isOfficeLead` boolean, nullable — Whether this is an office lead. - `coBrokerCompany` string, nullable — The co-broker company. - `email` string, nullable — Contact email for this sale. - `property` unknown - `commission` unknown - `sellers` unknown[], nullable — Array of seller information. - unknown - `buyers` unknown[], nullable — Array of buyer information. - unknown - `titleContact` unknown - `escrowContact` unknown - `attorneyContact` unknown[], nullable — Array of attorney contacts. - unknown - `lenderContact` unknown - `otherSideAgentContact` unknown - `homeWarrantyContact` unknown - `miscContact` unknown - `commercialLease` unknown - `commissionBreakdowns` unknown[], nullable — Commission breakdown details. - unknown - `coAgentGuids` string[], nullable — Array of co-agent GUIDs. - `commissionSplits` unknown[], nullable — Commission split information. - unknown - `stage` unknown - `commissionReferral` unknown - `agent` unknown[], nullable — Agent information. - unknown - `coAgents` unknown[], nullable — Co-agent information. - unknown - `transactionCoordinators` BulkExportTransactionCoordinator[], nullable — Array of transaction coordinators assigned to this sale. - `contactGuid` string, guid — The contact GUID of the transaction coordinator. - `firstName` string, nullable — The first name of the transaction coordinator. - `lastName` string, nullable — The last name of the transaction coordinator. - `fullName` string, nullable — The full name of the transaction coordinator. - `email` string, nullable — The email address of the transaction coordinator. - `phone` string, nullable — The phone number of the transaction coordinator. - `tcFee` number, nullable — The transaction coordinator fee. - `hasAccess` boolean — Whether the transaction coordinator has access to the file. - `earnestMoneyDeposit` unknown - `customFields` unknown - `createdOn` string, date-time — When this sale was created. - `checklist` BulkExportChecklist - `typeId` integer, nullable — The checklist type ID. - `typeName` string, nullable — The checklist type name. - `activities` BulkExportChecklistActivity[], nullable — Array of checklist activities. - `order` integer — The display order of the activity. - `activityId` integer — The unique identifier for this activity. - `activityName` string, nullable — The name of the activity. - `dateAssigned` string, nullable — When this activity was assigned. - `typeId` integer — The activity type ID. - `typeName` string, nullable — The activity type name. - `status` string, nullable — The current status of the activity. - `help` string, nullable — Help text for the activity. - `modifiedOn` string, date-time, nullable — When this activity was last modified. - `docs` string[], nullable — Array of document filenames attached to this activity. - `documents` BulkExportChecklistDocument[], nullable — Array of documents with GUIDs and names attached to this activity. - … - `comments` BulkExportChecklistComment[], nullable — Array of comments on this activity. - … - BulkExportListing - `objectType` string, nullable — The type of the object. Always 'listing' for this object. - `listingGuid` string, guid — The GUID for this listing. - `agentGuid` string, guid, nullable — The GUID of the primary agent. - `createdByGuid` string, guid, nullable — The GUID of the user who created this listing. - `coListingAgentGuid` string, guid, nullable — The GUID of the co-listing agent. - `referringAgentGuid` string, guid, nullable — The GUID of the referring agent. - `mlsNumber` string, nullable — The MLS number for this listing. - `status` string, nullable — The current status of the listing (active, expired, canceled, etc). Returns "Unknown" for status ids not yet mapped by the API. - `modifiedOn` string, date-time, nullable — When this listing was last modified. - `officeId` integer, nullable — The office ID. - `officeGuid` string, guid, nullable — The office GUID. - `checklistType` string, nullable — The checklist type. - `type` string, nullable — The type of listing. - `listingDate` string, date-time, nullable — The date the property was listed. - `source` string, nullable — The source of this listing. - `otherSource` string, nullable — Other source information if applicable. - `fileId` string, nullable — The file ID. - `commission` unknown - `expirationDate` string, date-time, nullable — The expiration date of the listing. - `deadDate` string, date-time, nullable — The date the listing was cancelled. Null if the listing has not been cancelled. - `company` string, nullable — The listing company. - `listingPrice` number, nullable — The listing price. - `email` string, nullable — Contact email for this listing. - `property` unknown - `commercialLease` unknown - `sellers` unknown[], nullable — Array of seller information. - unknown - `homeWarrantyContact` unknown - `miscContact` unknown - `stage` unknown - `coAgentGuids` string[], nullable — Array of co-agent GUIDs. - `agent` unknown[], nullable — Agent information. - unknown - `coAgents` unknown[], nullable — Co-agent information. - unknown - `transactionCoordinators` BulkExportTransactionCoordinator[], nullable — Array of transaction coordinators assigned to this listing. - `contactGuid` string, guid — The contact GUID of the transaction coordinator. - `firstName` string, nullable — The first name of the transaction coordinator. - `lastName` string, nullable — The last name of the transaction coordinator. - `fullName` string, nullable — The full name of the transaction coordinator. - `email` string, nullable — The email address of the transaction coordinator. - `phone` string, nullable — The phone number of the transaction coordinator. - `tcFee` number, nullable — The transaction coordinator fee. - `hasAccess` boolean — Whether the transaction coordinator has access to the file. - `customFields` unknown - `createdOn` string, date-time — When this listing was created. - `checklist` BulkExportChecklist - `typeId` integer, nullable — The checklist type ID. - `typeName` string, nullable — The checklist type name. - `activities` BulkExportChecklistActivity[], nullable — Array of checklist activities. - `order` integer — The display order of the activity. - `activityId` integer — The unique identifier for this activity. - `activityName` string, nullable — The name of the activity. - `dateAssigned` string, nullable — When this activity was assigned. - `typeId` integer — The activity type ID. - `typeName` string, nullable — The activity type name. - `status` string, nullable — The current status of the activity. - `help` string, nullable — Help text for the activity. - `modifiedOn` string, date-time, nullable — When this activity was last modified. - `docs` string[], nullable — Array of document filenames attached to this activity. - `documents` BulkExportChecklistDocument[], nullable — Array of documents with GUIDs and names attached to this activity. - … - `comments` BulkExportChecklistComment[], nullable — Array of comments on this activity. - … - BulkExportSummary - `objectType` string, nullable — The type of the object. Always 'summary' for this object. - `numberOfSales` integer — The number of sales in the export. - `numberOfListings` integer — The number of listings in the export. - `numberOfUsers` integer — The number of users in the export. - `createdOn` string, date-time — The date that this request was made. - `links` unknown[], nullable — Array of HATEOAS links for related resources. - unknown ## Other responses - `404` - `422` --- [API](https://skmtc.net/skyslope/apis/skyslope-api.md) · [All operations](https://skmtc.net/skyslope/apis/skyslope-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/skyslope/skyslope-api/revisions/bad0d2db9b7a/schema)