v1
latestOpenAPI 3.0.12026-07-22120163333.7 KBTransactions V2
List Transactions
Search and list transactions with pagination and optional keyword filter.
get/v2.0/transactions
Query parameters
pageSizeinteger
Page size; must be between 1 and 100.
pageNuminteger
Page number (0-based); must be >= 0.
queryKeystring
Search keyword. Performs a contains-style fuzzy match (first 15 characters only) against transaction name, property address, or the associated lead name; matching any one field is sufficient.
leadIdinteger
Optional. Restrict results to transactions belonging to this lead.
transactionType'Purchase' | 'Listing' | 'Lease' | 'Other' | 'All'
Optional. Filter by transaction type: Purchase, Listing, Lease, Other, or All to return every type in a single call. Case-insensitive. Defaults to Purchase when omitted.
Headers
Authorizationstring required
Bearer [access_token]
Response
Successful operation
Example response
{
"pageSize": 20,
"totalCount": 123,
"pageData": [
{
"created": 1518078026000,
"updated": 1518078026000,
"transactionId": 10001,
"leadId": 100001,
"propertyId": 20001,
"transactionName": "123 Main St",
"leadName": "Bob Smith",
"agentName": "Jane Doe",
"assignedAgent": 100001,
"transactionType": "Purchase",
"transactionStatus": "Pre-contract",
"homePrice": 1000000,
"expectedCloseDate": 1508580010000,
"closeDate": 1508580010000,
"commissionRate": 3,
"gci": 5000,
"teamRevenue": 1000,
"agentRevenue": 4000,
"appointmentDate": 1508580010000,
"agreementSignedDate": 1508580010000,
"offerDate": 1508580010000,
"contractDate": 1508580010000,
"appraisalDate": 1508580010000,
"homeInspectionDate": 1508580010000,
"escrowDate": 1508580010000,
"expiration": 1508580010000
}
]
}