> ## Documentation Index > Fetch the complete documentation index at: https://developer.lofty.com/llms.txt > Use this file to discover all available pages before exploring further. # List Transactions > Search and list transactions with pagination and optional keyword filter. ## OpenAPI ````yaml openapi/openapi.json GET /v2.0/transactions openapi: 3.0.1 info: title: Lofty Service Open APIs description: Lofty service API description version: '1.0' servers: - url: https://api.lofty.com security: [] tags: - name: Tasks & Appointments V2 description: >- Unified V2 API for lead tasks and appointments: list, create, read, update, finish, unfinish and delete. Tasks and appointments share the same taskId namespace; each endpoint resolves the target by ID regardless of underlying type. - name: Opportunity description: Operations about opportunity - name: Communication V2 description: >- Fetch a single communication record (text / email / call) by its communication ID. Closes the webhook follow-up gap where only list-by-lead endpoints existed for text and email. - name: Vendor description: >- Team vendor directory: team members, sub-accounts and associated agents within the caller's team. - name: Lead Routing description: >- Lead routing configuration: read and update routing rules and default (supplement) rules per business type, and list the members and roles available for assignment. - name: Lead Activity V2 API description: >- Unified lead activity timeline: returns call, text and email activities for a lead in chronological order, including both auto-captured and agent-logged entries. - name: Tasks & Appointments description: >- Agent tasks and lead appointments. Supports listing a lead's appointments, listing / reading / creating / updating / deleting tasks on a lead. - name: Transactions V2 description: V2 transaction APIs. - name: Lead Manual Log description: >- Agent-recorded log of communications that happened outside the Lofty CRM (calls placed on a personal line, emails sent from another mailbox, SMS sent from another device). Three channels are supported: logCall, logEmail, logText. Direction fields are recorded from the agent's point of view: 'outbound' = agent -> lead, 'inbound' = lead -> agent. Persistence is asynchronous: a POST returns the new entry's ID once the write is enqueued, and the entry becomes readable after a short delay. - name: Calls description: >- Calls placed or received through the Lofty dialer. Supports fetching a recording URL, retrieving a single call record, and listing calls attached to a lead. - name: Listing V2 description: Listing search V2 - name: Agent User description: >- Agent onboarding and team directory operations. Create a new agent under the caller's team and attach tags to existing agents. - name: Sales Agents V2 description: >- Sales Agent (AI Assistant) management: read the caller's assistant and quota, query leads followed by AI, mute leads, manage working-pool membership and plan tasks, and update Sales Agent settings. - name: Calendar V2 API description: >- Unified V2 API for tasks and appointments on a lead: create, update, delete, finish, unfinish, query a paginated list, and find available meeting slots. Calendar IDs returned by POST /v2.0/calendar are composite strings of the form '-task' or '-appointment' and must be sent back as-is to the per-entry endpoints. - name: Lead System Logs description: Query a lead's system log. - name: Lead Transaction description: Operations about leads - name: Notifications V2 description: Operations for sending notifications to agents - name: Notes description: >- Free-text notes attached to a lead. Supports create, list, get-by-id, update and delete. Notes may be pinned to surface them at the top of the lead's timeline. System-generated notes (automated activity) are included on the list endpoint only when explicitly requested. - name: Listing description: >- Listing data access: retrieve published listings for a site feed (XML), and search active / sold listings by agent, office or MLS id. - name: Intelligent Features description: AI-powered features for lead analysis and communication - name: Leads description: >- Lead lifecycle operations: create / read / update / delete a lead, search leads by stage, source, tag, create time or update time, place an inquiry or property on a lead, list lead activities, resolve assignee by lead info, and handle Brokermint contact callbacks. - name: Members description: >- Team member directory: look up members by user ID, by account (email), or list all members of the caller's team. Also supports retrieving the current user's profile. - name: Team Features description: >- Team-scoped metadata: lead tags, custom fields, and lead ponds. Supports listing existing entries, adding a new custom field, and retrieving a specific lead pond. - name: Agent Organization description: >- Team organizational structure: read the caller's organization info, manage company and office records, and list permission profiles available to the team. - name: Communication description: >- Lead communication history and outbound messaging: list call / email / text history for a lead, search communications for an agent, and send SMS or email to a lead. - name: Webhooks description: > Use webhooks to be notified about events that happen in a lofty account. Supported webhook event types (listId): | listId | Event Type | Description | |--------|-----------|-------------| | 1 | Agent Info | Agent created or updated | | 2 | Lead Info | Lead created, updated, or deleted | | 3 | Lead Activity | Lead site activity (e.g. SiteBrowse, SiteFavorite, SiteSearch) | | 4 | Listing Alert | Listing alert changed | | 5 | Transaction | Transaction created, updated, or deleted | | 6 | Call | Call event (MANUAL and LOGGED only, excludes AUTO) | | 7 | Email | Email event (MANUAL and LOGGED only, excludes AUTO) | | 8 | Text | Text message event (MANUAL and LOGGED only, excludes AUTO) | | 9 | Note | Note created, updated, or deleted | | 10 | Task | Task created, updated, finished, or deleted | | 11 | Appointment | Appointment created, updated, finished, or deleted | | 12 | Pipeline Change | Lead pipeline stage changed | ### Notification Recipient Rules Here "team" means the entire Lofty client account (the organization), not the Lofty "Team add-on" product. Which subscribed users receive a callback depends on the subscription's delivery mode (`permissionMode`). In both modes, only users in the lead's account (team) who have subscribed to the event type are considered. **Assignment-based delivery — `permissionMode: 0` (default)** A subscriber receives the callback only for leads assigned to them or that they administer: - If the lead is a **hidden lead**, only the **assigned agent** receives the notification. - Otherwise, the subscriber receives it if they are the **assigned agent** of the lead, or a **Company Owner** or **Company Admin**. - All other subscribers do **not** receive the notification. **Ownership-based delivery — `permissionMode: 1`** A subscriber receives the callback for any lead they manage, regardless of who it is assigned to: - Every assignment-based case above still applies (assigned agent, Company Owner / Company Admin). - In addition, the subscriber receives the callback for any lead within their **ownership scope** — a lead owned by their **team** or **office**, or **personally owned** by them — even if it is assigned to someone else. - Hidden leads are still delivered only to users who manage them. Ownership-based mode is intended for team/account-level integrations that must cover every lead in their scope, not only assigned leads. Set `permissionMode` when creating the subscription (POST /v1.0/webhook); it defaults to `0`, so existing subscriptions are unaffected. ### Delivery Timing Webhooks are typically delivered within **1 minute** of the event being triggered. During periods of high traffic, delivery may be delayed, but will always be sent within **5 minutes**. For detailed callback payload structures, see [Webhook Event Payloads](/concepts/webhooks#event-payloads). paths: /v2.0/transactions: get: tags: - Transactions V2 summary: List Transactions description: >- Search and list transactions with pagination and optional keyword filter. operationId: searchTransactions parameters: - name: pageSize in: query description: Page size; must be between 1 and 100. required: false schema: type: integer format: int32 default: 20 example: 20 - name: pageNum in: query description: Page number (0-based); must be >= 0. required: false schema: type: integer format: int32 default: 0 example: 0 - name: queryKey in: query description: >- 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. required: false schema: type: string example: 123 - name: leadId in: query description: Optional. Restrict results to transactions belonging to this lead. required: false schema: type: integer format: int64 example: 100001 - name: transactionType in: query description: >- 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. required: false schema: type: string enum: - Purchase - Listing - Lease - Other - All example: All - name: Authorization in: header description: Bearer [access_token] required: true schema: type: string responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/TransactionV2PageResponse' '400': description: >- pageNum < 0 or unrecognized transactionType (20012 INVALID_PARAMETER), or pageSize out of range (20042 LIMIT_NOT_VALID). content: application/json: schema: type: string '401': description: Missing or invalid authentication token. content: application/json: schema: type: string '500': description: Internal server error. content: application/json: schema: type: string components: schemas: TransactionV2PageResponse: type: object properties: pageNum: type: integer description: Page number (0-based). format: int32 example: 0 pageSize: type: integer description: Page size. format: int32 example: 20 totalCount: type: integer description: Total number of matching transactions. format: int64 example: 123 pageData: type: array items: $ref: '#/components/schemas/TransactionV2Item' description: Paginated response for transaction search. TransactionV2Item: type: object properties: created: type: integer description: >- Transaction creation timestamp, in milliseconds since Unix epoch (UTC). format: int64 example: 1518078026000 updated: type: integer description: >- Transaction last-modified timestamp, in milliseconds since Unix epoch (UTC). format: int64 example: 1518078026000 transactionId: type: integer description: Transaction ID. format: int64 example: 10001 leadId: type: integer description: ID of the lead this transaction belongs to. format: int64 example: 100001 propertyId: type: integer description: ID of the property linked to this transaction. format: int64 example: 20001 transactionName: type: string description: Property address or deal name. example: 123 Main St leadName: type: string description: Name of the lead this transaction belongs to. example: Bob Smith agentName: type: string description: Name of the agent assigned to this transaction. example: Jane Doe assignedAgent: type: integer description: User ID of the agent this transaction is assigned to. format: int64 example: 100001 transactionType: type: string description: Transaction type. One of Purchase / Listing / Lease / Other. example: Purchase enum: - Purchase - Listing - Lease - Other transactionStatus: type: string description: Transaction status name as configured in the team's pipeline. example: Pre-contract homePrice: type: number description: Home price of the transaction. example: 1000000 expectedCloseDate: type: integer description: Expected close date, in milliseconds since Unix epoch (UTC). format: int64 example: 1508580010000 closeDate: type: integer description: Actual close date, in milliseconds since Unix epoch (UTC). format: int64 example: 1508580010000 commissionRate: type: number description: Commission rate, expressed as a percentage (e.g. 3 for 3%). example: 3 gci: type: number description: Gross Commission Income (GCI) of the transaction. example: 5000 teamRevenue: type: number description: Portion of the GCI attributed to the team. example: 1000 agentRevenue: type: number description: Portion of the GCI attributed to the agent. example: 4000 appointmentDate: type: integer description: Appointment date, in milliseconds since Unix epoch (UTC). format: int64 example: 1508580010000 agreementSignedDate: type: integer description: Agreement-signed date, in milliseconds since Unix epoch (UTC). format: int64 example: 1508580010000 offerDate: type: integer description: Offer date, in milliseconds since Unix epoch (UTC). format: int64 example: 1508580010000 contractDate: type: integer description: Contract date, in milliseconds since Unix epoch (UTC). format: int64 example: 1508580010000 appraisalDate: type: integer description: Appraisal date, in milliseconds since Unix epoch (UTC). format: int64 example: 1508580010000 homeInspectionDate: type: integer description: Home-inspection date, in milliseconds since Unix epoch (UTC). format: int64 example: 1508580010000 escrowDate: type: integer description: Escrow date, in milliseconds since Unix epoch (UTC). format: int64 example: 1508580010000 expiration: type: integer description: >- Expiration date (listing / contract), in milliseconds since Unix epoch (UTC). format: int64 example: 1508580010000 customFields: type: array description: Custom field values associated with the transaction. items: $ref: '#/components/schemas/CustomFieldRequest' description: Transaction summary item returned by the V2 search API. CustomFieldRequest: type: object properties: id: type: integer description: Custom field id format: int64 value: type: string description: >- Custom field value For multi_select, the format is:["Item1","Item2", ...] description: >- Custom field values; full-coverage update or insertion. See GET /v1.0/transaction/customfields for the team's custom field definitions. ````