> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.propexo.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.propexo.com/_mcp/server.

# Get a lead by ID

GET https://api.propexo.com/v1/leads/{id}

Get a lead by ID

Reference: https://docs.propexo.com/api-reference/pms-generic-ap-is/leads/get-a-lead-by-id

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.propexo.com` (Production, default)
- `https://api.sandbox.propexo.com` (Sandbox)

## Request

### Path parameters

- `id` (string, required) — The ID of the resource.

### Query parameters

- `order-by` (string, optional, default: created_at:desc) — Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc
- `updated_at_gte` (string, optional, nullable) — Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)
- `updated_at_lte` (string, optional, nullable) — Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)
- `last_seen_gte` (string, optional, nullable) — Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)
- `last_seen_lte` (string, optional, nullable) — Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)
- `offset` (integer, optional, nullable, default: 0) — Can be used for paginating results
- `limit` (integer, optional, nullable, default: 100) — A number between 1 and 250 to determine the number of results to return in a single query

## Response

### 200

Successful response

- `meta` (ResponseMeta, required)
- `results` (Lead, required)

## Errors

### 400 Bad Request Error

Bad Request

- `error` (ErrorResponseError, required)

## Types

### ResponseMeta

- `orderBy` (list of ResponseMetaOrderByItems, required)
- `offset` (integer, optional) — The offset of the first result
- `limit` (integer, optional) — The number of results to return
- `hasMore` (boolean, optional, nullable) — Whether there are more results
- `total` (integer, optional) — The total number of results

### Lead

- `id` (string, required) — The Propexo unique identifier for the lead
- `created_at` (string, required) — The date record first entered Propexo
- `updated_at` (string, required) — The date record was last updated in Propexo
- `last_seen` (string, required, nullable) — The date the record was last seen from the PMS
- `x_created_at` (string, required, nullable) — The date the record first entered the integration vendor
- `x_guestcard_id` (string, required, nullable) — The external ID of the guestcard from the integration vendor
- `x_id` (string, required) — The external ID from the integration vendor
- `x_leasing_agent_id` (string, required, nullable) — The external ID of the leasing agent from the integration vendor
- `x_property_id` (string, required) — The external ID of the property from the integration vendor
- `x_unit_id_preferred` (list of string, required)
- `x_updated_at` (string, required, nullable) — The date the record was last updated in the integration vendor
- `x_lead_source_id` (string, required, nullable) — The external ID of the lead source from the integration vendor
- `address_1` (string, required, nullable) — The first address line associated with the lead
- `address_2` (string, required, nullable) — The second address line associated with the lead
- `city` (string, required, nullable) — The city associated with the lead
- `country` (string, required, nullable) — The country associated with the lead
- `custom_data` (LeadCustomData, required, nullable)
- `date_of_birth` (string, required, nullable) — The date of birth associated with the lead
- `desired_amenities` (string, required, nullable) — The desired amenities associated with the lead
- `desired_floor_plan_id` (string, required, nullable) — The external ID of desired floor plan associated with the lead
- `desired_floor_plan_name` (string, required, nullable) — The desired floor plan name
- `desired_lease_term_in_months` (string, required, nullable) — The desired lease term
- `desired_max_rent_in_cents` (double, required, nullable) — The desired maximum rent
- `desired_max_square_ft` (double, required, nullable) — The desired maximum square feet
- `desired_min_rent_in_cents` (double, required, nullable) — The desired minimum rent
- `desired_min_square_ft` (double, required, nullable) — The desired minimum square feet
- `desired_num_bathrooms` (double, required, nullable) — The desired number of bathrooms
- `desired_num_bedrooms` (integer, required, nullable) — The desired number of bedrooms
- `desired_unit_number` (string, required, nullable) — The desired unit number
- `desired_unit_type` (string, required, nullable) — The desired unit type
- `email_1` (string, required, nullable) — The primary email address associated with the lead
- `email_2` (string, required, nullable) — The secondary email address associated with the lead
- `first_name` (string, required, nullable) — The first name associated with the lead
- `ils` (string, required, nullable) — The name of the Internet listing service
- `last_name` (string, required, nullable) — The last name associated with the lead
- `lead_source` (string, required, nullable) — The lead source
- `leasing_agent` (string, required, nullable) — The name of the leasing agent
- `middle_name` (string, required, nullable) — The middle name associated with the lead
- `notes` (string, required, nullable) — Notes associated with the lead
- `number_of_occupants` (integer, required, nullable) — The number of occupants
- `pets` (list of LeadPetsItems, required)
- `phone_1_type` (string, required, nullable) — Type of the primary phone number
- `phone_1` (string, required, nullable) — Primary phone number associated with the lead
- `phone_2_type` (string, required, nullable) — Type of the secondary phone number
- `phone_2` (string, required, nullable) — Secondary phone number associated with the lead
- `state` (string, required, nullable) — The state associated with the lead
- `status` (string, required, nullable) — The raw status associated with the lead
- `target_move_in_date` (string, required, nullable) — The target move in date
- `zip` (string, required, nullable) — The zip code associated with the lead
- `property_id` (string, required) — The Propexo unique identifier for the property
- `lead_source_id` (string, required, nullable) — The Propexo unique identifier for the lead source
- `unit_id_preferred` (list of string, required)
- `integration_id` (string, required) — The Propexo unique identifier for the integration
- `integration_vendor` (enum, required) — The property management system of record
  - Allowed values: `APPFOLIO`, `BUILDIUM`, `ENTRATA`, `MRI`, `PROPERTYWARE`, `PROPERTYWARE_REST`, `REALPAGE`, `REALPAGE_RPX`, `RENTMANAGER`, `RENTVINE`, `RESMAN`, `YARDI`, `YARDI_REST`
- `screenings` (list of LeadScreeningsItems, required)
- `x_unit_id` (string, required, nullable, deprecated) — DEPRECATED: Use x_unit_id_preferred instead
- `pet_details` (string, required, nullable, deprecated) — DEPRECATED: Use the pets array instead

### ErrorResponseError

- `code` (string, required)
- `message` (string, required)
- `details` (map from string to any, optional)

### ResponseMetaOrderByItems

### LeadCustomData

### LeadPetsItems

- `id` (string, required) — The Propexo unique identifier for the lead pet
- `created_at` (string, required) — The date record first entered Propexo
- `updated_at` (string, required) — The date record was last updated in Propexo
- `last_seen` (string, required, nullable) — The date the record was last seen from the PMS
- `x_id` (string, required) — The external ID from the integration vendor
- `age_in_years` (double, required, nullable) — The age in years of the lead pet
- `breed` (string, required, nullable) — The breed of the lead pet
- `color` (string, required, nullable) — The color of the lead pet
- `gender_raw` (string, required, nullable) — The raw value for the gender of the lead pet
- `is_fixed` (boolean, required, nullable) — Whether the lead pet is fixed
- `is_service_animal` (boolean, required, nullable) — Whether the lead pet is a service animal
- `name` (string, required, nullable) — The name associated with the lead pet
- `notes` (string, required, nullable) — Notes associated with the lead pet
- `type` (string, required, nullable) — The type associated with the lead pet
- `weight_in_pounds` (double, required, nullable) — The weight in pounds of the lead pet
- `custom_data` (LeadPetsItemsCustomData, required, nullable)

### LeadScreeningsItems

- `id` (string, required) — The Propexo ID of the screening
- `created_at` (string, required) — The date record first entered Propexo
- `last_seen` (string, required) — The date the record was last seen from the PMS
- `x_id` (string, required) — The external ID from the integration vendor
- `status_raw` (string, required, nullable) — The status/results of the screening
- `screening_date` (string, required, nullable) — The date the screening took place

### LeadPetsItemsCustomData

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "meta": {
    "orderBy": [
      {}
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": {
    "id": "lead_9f8b7c6d-1234-4a56-b789-0cdef1234567",
    "created_at": "2024-05-10T09:15:00Z",
    "updated_at": "2024-06-01T14:45:00Z",
    "last_seen": "2024-06-01T14:00:00Z",
    "x_created_at": "2024-05-09T08:00:00Z",
    "x_guestcard_id": "guestcard_987654321",
    "x_id": "external_lead_123456",
    "x_leasing_agent_id": "agent_456789",
    "x_property_id": "property_123abc",
    "x_unit_id_preferred": [
      "unit_789xyz",
      "unit_456def"
    ],
    "x_updated_at": "2024-06-01T13:30:00Z",
    "x_lead_source_id": "leadsource_321abc",
    "address_1": "123 Maple Street",
    "address_2": "Apt 4B",
    "city": "Springfield",
    "country": "USA",
    "custom_data": {},
    "date_of_birth": "1985-07-20",
    "desired_amenities": "Pool, Gym, Parking",
    "desired_floor_plan_id": "floorplan_001",
    "desired_floor_plan_name": "2 Bedroom Deluxe",
    "desired_lease_term_in_months": "12",
    "desired_max_rent_in_cents": 250000,
    "desired_max_square_ft": 1200.5,
    "desired_min_rent_in_cents": 150000,
    "desired_min_square_ft": 900,
    "desired_num_bathrooms": 2,
    "desired_num_bedrooms": 2,
    "desired_unit_number": "4B",
    "desired_unit_type": "Apartment",
    "email_1": "jane.doe@example.com",
    "email_2": "j.doe@workmail.com",
    "first_name": "Jane",
    "ils": "Zillow",
    "last_name": "Doe",
    "lead_source": "Online Listing",
    "leasing_agent": "Michael Smith",
    "middle_name": "A",
    "notes": "Interested in a quick move-in. Prefers top floor units.",
    "number_of_occupants": 3,
    "pets": [
      {
        "id": "pet_abc123",
        "created_at": "2024-05-10T09:20:00Z",
        "updated_at": "2024-06-01T14:00:00Z",
        "last_seen": "2024-06-01T13:50:00Z",
        "x_id": "external_pet_001",
        "age_in_years": 4.5,
        "breed": "Labrador Retriever",
        "color": "Yellow",
        "gender_raw": "Female",
        "is_fixed": true,
        "is_service_animal": false,
        "name": "Bella",
        "notes": "Very friendly and well-trained.",
        "type": "Dog",
        "weight_in_pounds": 65,
        "custom_data": {}
      }
    ],
    "phone_1_type": "mobile",
    "phone_1": "+1-555-123-4567",
    "phone_2_type": "work",
    "phone_2": "+1-555-987-6543",
    "state": "IL",
    "status": "active",
    "target_move_in_date": "2024-07-01",
    "zip": "62704",
    "property_id": "prop_456def",
    "lead_source_id": "leadsource_789ghi",
    "unit_id_preferred": [
      "unit_789xyz",
      "unit_456def"
    ],
    "integration_id": "integration_001",
    "integration_vendor": "APPFOLIO",
    "screenings": [
      {
        "id": "screening_123abc",
        "created_at": "2024-05-15T10:00:00Z",
        "last_seen": "2024-05-20T12:00:00Z",
        "x_id": "external_screening_001",
        "status_raw": "approved",
        "screening_date": "2024-05-14"
      }
    ],
    "x_unit_id": "unit_789xyz",
    "pet_details": "2 dogs, both medium size"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.propexo.com/v1/leads/id"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.propexo.com/v1/leads/id';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.propexo.com/v1/leads/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.propexo.com/v1/leads/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.propexo.com/v1/leads/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.propexo.com/v1/leads/id', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.propexo.com/v1/leads/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/leads/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```