> ## 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. # Get Lead > Returns a single lead by ID. The response is wrapped under the 'lead' key. Notes: - By default, trashed leads are not returned. Pass withTrash=true to include them. - Caller must have access to the lead; otherwise 404 LEAD_NOT_EXIST. ## OpenAPI ````yaml openapi/openapi.json GET /v1.0/leads/{leadId} 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: /v1.0/leads/{leadId}: get: tags: - Leads summary: Get Lead description: >- Returns a single lead by ID. The response is wrapped under the 'lead' key. Notes: - By default, trashed leads are not returned. Pass withTrash=true to include them. - Caller must have access to the lead; otherwise 404 LEAD_NOT_EXIST. operationId: get parameters: - name: leadId in: path description: ID of the lead to retrieve. required: true schema: minimum: 1 type: integer format: int64 example: 100001 - name: withTrash in: query description: When true, include trashed leads in the lookup. required: false schema: type: boolean default: false example: false - name: Authorization in: header description: Bearer [access_token] required: true schema: type: string responses: '200': description: Lead retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/LeadResponse' '401': description: Missing or invalid authentication token. content: application/json: schema: type: string '404': description: Lead does not exist or is not accessible (20006 LEAD_NOT_EXIST). content: application/json: schema: type: string '500': description: Internal server error. content: application/json: schema: type: string components: schemas: LeadResponse: type: object properties: cannotText: type: boolean description: 'false: can send message to the lead' cannotCall: type: boolean description: 'false: can call to the lead' cannotEmail: type: boolean description: 'false: can email to the lead' leadId: type: integer description: The Id of the lead format: int64 leadUserId: type: integer description: The user Id of the lead format: int64 firstName: type: string description: The first/given name of the lead lastName: type: string description: The last/family name of the lead birthday: type: string description: The birthday of the lead emails: type: array description: The email list of the lead example: - jane.doe@example.com - jdoe-work@company.com items: type: string example: jane.doe@example.com phones: type: array description: The phone list of the lead example: - '+14155551234' - '+12125559876' items: type: string example: '+14155551234' leadSource: type: integer description: The leadSource(Id) about the lead format: int32 source: type: string description: The source of the lead stageId: type: integer description: The stageId of the lead format: int64 stage: type: string description: The stage of the lead assignedUserId: type: integer description: The user Id of the lead assigned to format: int64 assignedUser: type: string description: The Username of the lead assigned to lenderUserId: type: integer description: The user Id of the lead's lender format: int64 score: type: integer description: The score of the lead format: int32 tags: type: array description: The tags of the lead items: $ref: '#/components/schemas/UserLeadTagVo' teamId: type: integer description: The teamId of the lead's team format: int64 streetAddress: type: string description: >- The streetAddress associated with the lead. Deprecated: please use the streetAddress field in leadPropertyList instead. deprecated: true city: type: string description: >- The city associated with the lead. Deprecated: please use the city field in leadPropertyList instead. deprecated: true state: type: string description: >- The state associated with the lead. Deprecated: please use the state field in leadPropertyList instead. deprecated: true zipCode: type: string description: >- The zip code associated with the lead. Deprecated: please use the zipCode field in leadPropertyList instead. deprecated: true createTime: type: string description: The create time of the lead assignTime: type: string description: The assigned time of the lead facebook: type: string description: The Facebook account of the lead twitter: type: string description: The Twitter account of the lead hiddenFlag: type: boolean description: The lead is hidden or not referredBy: type: string description: The referee of the lead leadInquiry: $ref: '#/components/schemas/LeadInquiry' leadPropertyList: type: array description: LeadPropertyList items: $ref: '#/components/schemas/LeadProperty' customAttributes: type: array description: User customized field items: $ref: '#/components/schemas/CustomAttribute' lastUpdateTime: type: string description: The update time of the lead groups: type: array description: The groups that the lead in. Deprecated, use segments instead. example: - VIP Clients - Open House Feb deprecated: true items: type: string example: VIP Clients segments: type: array description: The segments that the lead in example: - First-Time Buyers - Downtown Area items: type: string example: First-Time Buyers unsubscription: type: boolean description: Unsubscription the email leadTypes: type: array description: >- Types of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Renter (5), Investor (6), Agent (7), Homeowner (8), Landlord (9) example: - 2 - 5 items: type: integer format: int32 example: 2 lastTouch: type: string description: The last touch time of the lead lastVisit: type: string description: The last visit time of the lead phoneStatuses: type: array description: >- The status of the phone number Type id: invaild number(1), vaild number(2), talked(3), DNC Number(4), DNC Contact(5) example: - 2 - 3 items: type: integer format: int32 example: 2 assignCompletionStatus: type: boolean description: Whether complete all lead assign process buyingTimeFrame: type: string description: >- buying time frame, `1-3`, `3-6`, `6-12`, `12+`, `Just Looking`, `Refinancing`. example: 6-12 preQual: type: string description: Pre-qual, `Yes` or `No` example: 'Yes' houseToSell: type: string description: House to Sell, `Yes` or `No` example: 'Yes' fthb: type: string description: first time home buyer, `Yes` or `No` example: 'Yes' withBuyerAgent: type: string description: With buyer Agent, `Yes` or `No` example: 'Yes' sellingTimeFrame: type: string description: >- selling time frame, `1-3`, `3-6`, `6-12`, `12+`, `Just Looking`, `Refinancing`. example: 1-3 mortgage: type: string description: Mortgage, `Yes` or `No`. example: 'Yes' buyHouse: type: string description: Buy a house, `Yes` or `No`. example: 'Yes' withListingAgent: type: string description: With listing agent, `Yes` or `No`. example: 'Yes' opportunity: type: string description: >- The lead's current opportunity type, derived from on-platform lead scoring. One of: "High Interest", "Sell", "Back to Site", "Back on Market". Null when the lead has no active opportunity. example: High Interest enum: - High Interest - Sell - Back to Site - Back on Market leadFamilyMemberList: type: array description: A list of family members associated with the lead items: $ref: '#/components/schemas/LeadFamilyMember' pondId: type: integer description: The Id of the lead's pond format: int64 pondName: type: string description: The Name of the lead's pond customRoleList: type: array items: $ref: '#/components/schemas/CustomRole' language: type: string description: The language of the lead ownershipId: type: integer description: >- The entity ID associated with `ownershipScope`: the office ID when scope is `OFFICE`, or the agent's user ID when scope is `PERSONAL`. Not applicable when scope is `TEAM`. format: int64 ownershipScope: type: string description: >- The visibility scope of the lead. `TEAM` — Account-wide: visible to all users in this Lofty client account. `OFFICE` — visible only within a specific office. `PERSONAL` — visible only to a single agent. Note: `TEAM` refers to the entire client account (the organization), not the Lofty "Team add-on" product. UserLeadTagVo: type: object properties: leadId: type: integer format: int64 tagId: type: integer format: int64 createTime: type: string updateTime: type: string tagName: type: string creatorUserId: type: integer format: int64 visibleType: type: integer format: int32 description: The tags of the lead LeadInquiry: type: object properties: priceMin: type: integer description: Price range lower end format: int64 example: 1 priceMax: type: integer description: Price range higher end format: int64 example: 10000000 propertyType: type: array description: >- Property types: `Single Family Home`, `Multi-Family`, `Condo`, `Townhouse`, `Mobile Home`, `Manufactured Home`, `Vacant Land`, `Commercial`. example: - Single Family Home - Condo items: type: string example: Single Family Home bedroomsMin: type: integer description: Bed Rooms format: int32 example: 1 bathroomsMin: type: string description: Bath Rooms example: '1' locations: type: array description: >- Areas the lead is interested in. Each entry is a Location object (city, stateCode, zipCode, county, streetAddress or description). Used by routing rules when the lead's leadTypes do not include Seller (1). example: - city: Austin stateCode: TX items: $ref: '#/components/schemas/Location' id: type: integer format: int64 leadUserId: type: integer format: int64 bedroomsMax: type: integer format: int32 bathroomsMax: type: string modifyByAgent: type: boolean createTime: type: string format: date-time updateTime: type: string format: date-time defaultValue: type: boolean description: LeadInquirys LeadProperty: type: object properties: price: type: integer description: |- The price Applies to lead routing only if the leadType field is Seller(1) format: int64 example: 100000 state: type: string description: |- The state Applies to lead routing only if the leadType field is Seller(1) example: California city: type: string description: |- The city Applies to lead routing only if the leadType field is Seller(1) example: New York streetAddress: type: string description: |- The street address Applies to lead routing only if the leadType field is Seller(1) example: 22348 Regnart RD zipCode: type: string description: |- The zip code Applies to lead routing only if the leadType field is Seller(1) example: '25401' county: type: string description: |- The county Applies to lead routing only if the leadType field is Seller(1) propertyType: type: string description: >- Property type: `Single Family Home`, `Multi-Family`, `Condo`, `Townhouse`, `Mobile Home`, `Manufactured Home`, `Vacant Land`, `Commercial`. example: Single Family Home bedrooms: type: integer description: The bed rooms. format: int32 example: 3 bathrooms: type: number description: The bath rooms. format: double example: 2 squareFeet: type: integer description: The square feet. format: int64 example: 100 lotSize: type: number description: The lot size (acreage). format: double example: 26.33 parkingSpace: type: integer description: The parking space. format: int64 example: 1 floors: type: integer description: The floors. format: int32 example: 1 mailAddress: type: boolean description: >- If set to true, the address is a mailing address; otherwise, it is a property address. id: type: integer description: >- The property ID. Required when updating an existing mailing address or property address. If not provided, a new address will be created. format: int64 leadUserId: type: integer format: int64 listingId: type: string autoListingId: type: integer format: int64 label: type: string note: type: string listingStatus: type: string labelList: type: string pictureUrl: type: string siteListingUrl: type: string labelType: type: string priceMax: type: integer description: |- The max price Applies to lead routing only if the leadType field is Seller(1) format: int64 writeOnly: true example: 10000000 priceMin: type: integer description: |- The min price Applies to lead routing only if the leadType field is Seller(1) format: int64 writeOnly: true example: 100000 description: Lead property or mailing address details CustomAttribute: required: - attributeName - attributeType - value type: object properties: attributeName: type: string description: The name of this custom field attributeType: type: string description: The type of the field example: >- number, text, date, anniversary_date, single_select, multi_select, percentage, currency value: type: string description: >- The content of the field for lead, value for multi-select,such as "[\"item1\",\"item2\s",...]" .It's unnecessary when adding a new custom field for team params: type: string description: options for select, such as {"option":["item1","item2",...]} description: User customized field LeadFamilyMember: required: - firstName type: object properties: relationship: type: string description: >- The relationship of this family member to primary lead. Example: Husband firstName: type: string description: The first name of the family member lastName: type: string description: The last name of the family member phones: type: array description: >- A list of phone numbers associated with the family member. (No more than 20 characters per phone) example: - '+14155551234' items: type: string example: '+14155551234' emails: type: array description: A list of email addresses associated with the lead example: - spouse@example.com items: type: string example: spouse@example.com birthday: type: string description: The birthday of the family member(pattern:MMM d, yyyy) description: A list of family members associated with the lead CustomRole: required: - role - roleId type: object properties: roleId: type: integer description: The ID of this custom role format: int32 role: type: string description: The name of this custom role assigneeId: type: integer description: The user id of this custom role format: int64 assignee: type: string description: The user account of this custom role Location: type: object properties: stateCode: type: string description: >- The state code of city Applies to lead routing if the leadType field is not Seller(1) in the lead creation request. example: CA city: type: string description: >- The city Applies to lead routing if the leadType field is not Seller(1) in the lead creation request. example: Palm Desert zipCode: type: string description: >- The zip code Applies to lead routing if the leadType field is not Seller(1) in the lead creation request. example: '92211' county: type: string description: >- The county Applies to lead routing if the leadType field is not Seller(1) in the lead creation request. streetAddress: type: string description: >- The street address Applies to lead routing if the leadType field is not Seller(1) in the lead creation request. description: type: string description: Description of location. example: other description: >- Areas the lead is interested in. Each entry is a Location object (city, stateCode, zipCode, county, streetAddress or description). Used by routing rules when the lead's leadTypes do not include Seller (1). example: - city: Austin stateCode: TX ````