Skip to main content
GET
List Transactions

Headers

Authorization
string
required

Bearer [access_token]

Query Parameters

pageSize
integer<int32>
default:20

Page size; must be between 1 and 100.

pageNum
integer<int32>
default:0

Page number (0-based); must be >= 0.

queryKey
string

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.

leadId
integer<int64>

Optional. Restrict results to transactions belonging to this lead.

transactionType
enum<string>

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.

Available options:
Purchase,
Listing,
Lease,
Other,
All

Response

Successful operation

Paginated response for transaction search.

pageNum
integer<int32>

Page number (0-based).

Example:

0

pageSize
integer<int32>

Page size.

Example:

20

totalCount
integer<int64>

Total number of matching transactions.

Example:

123

pageData
object[]