Propexo

https://docs.propexo.com/
Admin
Propexo provides a unified API for quick and easy integration with leading property management...
Tokens:1,155,928
Snippets:2,138
Trust Score:6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Propexo First Sync Complete Webhook Example (JSON)

Source: https://docs.propexo.com/documentation/getting-started/system-overview

This JSON snippet illustrates a 'FIRST_SYNC_COMPLETE' webhook payload. It indicates the completion of the initial synchronization process, providing details about the integration and the success of the sync jobs.

```json
{
  "trigger": "FIRST_SYNC_COMPLETE",
  "data": {
    "event": "FIRST_SYNC_COMPLETE",
    "integration_id": "cly301lrc000009jvbp6vaz7i",
    "vendor": "PROPERTYWARE",
    "successful_job_count": 5,
    "failed_job_count": 0,
    "is_sync_finished": true
  }
}
```

--------------------------------

### Get Property List by ID using CURL

Source: https://docs.propexo.com/api-reference/api-reference/properties/get-a-property-list-by-id

Example of how to retrieve a property list by its ID using `curl`. This command sends a GET request to the specified endpoint, including necessary headers for authorization.

```bash
curl -X GET \
  https://api.propexo.com/v1/property-lists/{property_list_id} \
  -H 'Authorization: Bearer YOUR_AUTH_TOKEN'
```

--------------------------------

### Sample Units Response - JSON

Source: https://docs.propexo.com/use-cases/use-cases/lead-to-lease

This JSON object is a sample response from the Propexo API's /units endpoint. It contains metadata and a list of units, each detailed with its ID, property and integration IDs, number of bathrooms and bedrooms, location details, availability status, rent information, and square footage. This data is crucial for presenting matching units to prospects.

```json
{
  "meta": {
    "offset": 0,
    "limit": 0,
    "orderBy": [],
    "hasMore": true
  },
  "results": [
    {
      "id": "<propexo>",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "x_id": "1234",
      "x_property_id": "3456",
      "bathrooms": "2",
      "bedrooms": "2",
      "city": "Boston",
      "is_available": true,
      "is_furnished": false,
      "is_listed": true,
      "is_vacant": true,
      "rent_amount_market_in_cents": 500000,
      "rent_amount_max_in_cents": 550000,
      "rent_amount_min_in_cents": 350000,
      "square_feet": 1012,
      "state": "MA",
      "street_address_1": "123 Main st",
      "zip": "02108",
      "integration_id": "xyz"
    }
  ]
}
```

--------------------------------

### GET /v1/admin/logs/jobs/{id}

Source: https://docs.propexo.com/api-reference/api-reference/admin/get-logs-by-job-id

Retrieves all log entries for a specified job ID. Jobs can have multiple log entries, for example, in the case of retries on failed jobs. This endpoint supports pagination and ordering.

```APIDOC
## GET /v1/admin/logs/jobs/{id}

### Description
Get all logs for a job ID. This returns an array because jobs can have multiple log entries (for example, in the case of retries on failed jobs).

### Method
GET

### Endpoint
/v1/admin/logs/jobs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the resource.

#### Query Parameters
- **order-by** (string) - Optional - Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc
- **offset** (integer | null) - Optional - Can be used for paginating results
- **limit** (integer | null) - Optional - A number between 1 and 250 to determine the number of results to return in a single query
- **include_all_jobs** (string) - Optional - Whether to include job logs from jobs that have spawned from the provided job id.

#### Header Parameters
- **Authorization** (string) - Required - Bearer authentication of the form `Bearer <token>`, where token is your auth token.

### Response
#### Success Response (200)
- **meta** (object) - Metadata about the response, including pagination information.
- **results** (array) - An array of log entries. Each entry has the following properties:
  - **id** (string) - The unique identifier for the log entry.
  - **job_id** (string | null) - The ID of the job associated with this log entry.
  - **created_at** (string) - The timestamp when the log entry was created.
  - **job_type** (string) - The type of the job.
  - **status** (string) - The status of the job.
  - **parent_job_id** (string | null) - The ID of the parent job, if this log is from a spawned job.
  - **root_job_id** (string) - The ID of the root job.
  - **job_schedule_id** (string | null) - The ID of the job schedule, if applicable.
  - **integration_id** (string) - The ID of the integration associated with the job.
  - **associated_property_id** (string | null) - The ID of the associated property, if applicable.

#### Response Example (200)
```json
{
  "meta": {
    "offset": 0,
    "limit": 10,
    "orderBy": [
      {
        "field": "created_at",
        "direction": "desc"
      }
    ],
    "hasMore": true,
    "total": 100
  },
  "results": [
    {
      "id": "log_abc123",
      "job_id": "job_xyz789",
      "created_at": "2023-10-27T10:00:00Z",
      "job_type": "data_import",
      "status": "completed",
      "parent_job_id": null,
      "root_job_id": "job_root456",
      "job_schedule_id": "schedule_def456",
      "integration_id": "int_ghi789",
      "associated_property_id": "prop_jkl012"
    }
  ]
}
```

#### Error Response (400)
- **Description**: Bad Request
- **Content**: {}
```

--------------------------------

### Next.js Module Loading and Initialization

Source: https://docs.propexo.com/api-reference/api-reference/construction-job-cost/create-construction-job_explorer=true

This snippet demonstrates how Next.js loads and initializes various modules and components. It includes the management of static assets and dynamic imports, crucial for the framework's rendering pipeline. Dependencies include the Next.js runtime.

```javascript
self.__next_f.push([1,"51:[["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69",[]],["dfd26db409373689fee06fbcd2afc88632041b41ceeb82f5734c473293c0a478",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69"]],["eaf4e01e06ab7739b23fe9f1d445266f161d67bf90272b30b2212ab13ba9355c",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","dfd26db409373689fee06fbcd2afc88632041b41ceeb82f5734c473293c0a478"]],["b4dfaef1951e7ffe11c54e2eb37dd842c3fdd3d50560681348ae6d051de4afc1",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","dfd26db409373689fee06fbcd2afc88632041b41ceeb82f5734c473293c0a478"]],["b59f5da2b1dca60f93fe28a050509bd49a138568fd47407ecfefccca9b032edd",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","dfd26db409373689fee06fbcd2afc88632041b41ceeb82f5734c473293c0a478"]],["1ebaa19760447fba519185d92fb59d48ecf38add5e5013a299fba7b57ccb1067",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","dfd26db409373689fee06fbcd2afc88632041b41ceeb82f5734c473293c0a478"]],["2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["8c9be0c61ad1804c42945b2c23600f86b560fc83479c8a5f3951be7a3dede9dd",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["cd060ec9a03b4fbdbb3b84e2ea5974b21fecab405a792732a69243d9963c1b0e",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["28a2d108fe3a93fbc2f098bf39a25c19a9756362b8dbdcf086982e4fad242c7f",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["82596e8867bf453776817b6450e9caadc53e7e8a46a67581271c7ba67d97fc98",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["dcb0ffa0565ff884d0cfdd0d27d17c2011c42adc3f11a024842474b7a60ac987",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["49a1aac1ca2e14c9db4d03a4eb8c2210cf650299cf54223245fc7ff075730a65",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["0dc6170d6903f1d2cea54172c6eb9e59e314e4fb3f70d5898c0e5a733d4eaac9",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["c92712a1be81945b45aa6942ae9b023089452a3fcfd9e3bba26088143b2c30b4",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["60c3fba4e7358ee19ff84a624dd14f7b08a6b00332e272146f969e34eb36346d",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["a553a3144ec83e32a2990c892d1de36d241725747e7ea928a205f4e11197f4d0",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["06b6d249447364335a97c031d0600da92d616257c2524696a433de64eade2f27",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["b8f8b6f045723f9cf0fb790839b7ccb7e13e096ceb1eeecef2e546611b038db4",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["0728303ac5caf8f97fba1261e47a3a01515a0e04b192ec88664997f3e50e33b0",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3f3d6092cf41415ed0f29ff44a0c9c2af37eedfa3230de9b0b9d10a970dd77"]],["ed9fbcfe8e1b94f109da2074f847fc706c6836a93e88329f4684f5125257abcf",["7b8ecb0ab5fad8ace8b874b533e557fab53fba63f25215c0852c663f230b1b69","2e3
```

--------------------------------

### Sample Amenities Response - JSON

Source: https://docs.propexo.com/use-cases/use-cases/lead-to-lease

This JSON object represents a sample response from the Propexo API's /amenities endpoint when queried for 'INTERNET'. It includes metadata about the request and a list of amenities, each with details like ID, associated property and unit IDs, cost, description, and normalized name.

```json
{
  "meta": {
    "offset": 0,
    "limit": 0,
    "orderBy": [],
    "hasMore": true
  },
  "results": [
    {
      "id": "<propexo>",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "x_id": "12345",
      "x_listing_id": "98765",
      "x_property_id": "3456",
      "x_unit_id": "1234",
      "cost_in_cents": 0,
      "description": "High speed internet",
      "image_urls": [],
      "name_normalized": "INTERNET",
      "name": "wifi",
      "integration_id": "xyz"
    }
  ]
}
```

--------------------------------

### Propexo Webhook Payload Example (JSON)

Source: https://docs.propexo.com/documentation/getting-started/system-overview

This JSON snippet demonstrates the structure of a 'DATA_UPDATE' webhook payload from Propexo. It specifically shows the 'diff' object, which contains only the changed fields, illustrating the minimal data sent in webhook notifications.

```json
{
  "data": {
    "event": "DATA_UPDATE",
    "object": "residents",
    "record_id": "cly301zs1000109jv26hx7hii",
    "diff": {
      "new": { "first_name": "Mary" },
      "previous": { "first_name": "Sarah" }
    }
  }
}
```

--------------------------------

### Example Webhook Payload from Propexo

Source: https://docs.propexo.com/documentation/webhooks/how-to-use-webhooks

This example illustrates the structure of a webhook request sent from Propexo to your system. It includes metadata about the object, integration ID, record ID, and a 'diff' object detailing the changes (previous and new states) to the record. This payload is simplified for demonstration purposes.

```bash
POST <your_path>
Host: <your_domain>
Content-Type: application/json
propexo-signature: <payload_signature>

{
    "meta": {
        "object": "leases",
        "integration_id": "cuid_1234567890",
    },
    "record_id": "cuid_1234567890",
    "diff": {
        "previous": { "status": "pending" },
        "new": { "status": "approved" }
    }
}
```

--------------------------------

### Get Job Log Link Request Example

Source: https://docs.propexo.com/api-reference/api-reference/admin/get-a-link-to-the-job-log-raw-request-and-response-data-of-a-write-job_explorer=true

This snippet demonstrates how to construct a request to retrieve a link to job log data. It requires the job log ID and an Authorization header for authentication. The response will contain the link if successful or an error message.

```http
GET /api/v1/admin/job-logs/{job_log_id}/link 
Host: api.propexo.com
Authorization: Bearer <YOUR_AUTH_TOKEN>
```

--------------------------------

### POST /api-reference/api-reference/admin/create-a-property-list-configuration

Source: https://docs.propexo.com/api-reference/api-reference/admin/get-a-link-to-the-job-log-raw-request-and-response-data-of-a-write-job_explorer=true

Creates a new property list configuration.

```APIDOC
## POST /api-reference/api-reference/admin/create-a-property-list-configuration

### Description
Creates a new property list configuration.

### Method
POST

### Endpoint
/api-reference/api-reference/admin/create-a-property-list-configuration

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **name** (string) - Required - The name of the property list configuration.

### Request Example
```json
{
  "name": "My New List"
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the newly created property list configuration.
- **name** (string) - The name of the property list configuration.

#### Response Example
```json
{
  "id": "uuid-string",
  "name": "My New List"
}
```
```

--------------------------------

### Integration Base Endpoints

Source: https://docs.propexo.com/api-reference/api-reference/admin/get-integration-by-id

This snippet lists the base endpoints for various property management system integrations. These base URLs are typically used as the starting point for all API calls to a specific system. Common systems included are Buildium, Propertyware, RentManager, RentVine, MRI, Knock, Sample3, and Funnel.

```text
- value: BUILDIUM_BASE
- value: PROPERTYWARE_BASE
- value: RENTMANAGER_BASE
- value: RENTVINE_BASE
- value: MRI_BASE
- value: KNOCK_BASE
- value: SAMPLE3_BASE
- value: FUNNEL_BASE
```

--------------------------------

### GET /v1/concessions/

Source: https://docs.propexo.com/api-reference/api-reference/units/get-all-concessions

Retrieves a list of all concessions available in the system.

```APIDOC
## GET /v1/concessions/

### Description
Retrieves a list of all concessions.

### Method
GET

### Endpoint
https://api.propexo.com/v1/concessions/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **concessions** (array) - A list of concession objects.
  - **id** (string) - The unique identifier for the concession.
  - **name** (string) - The name of the concession.
  - **location** (string) - The location of the concession.

#### Response Example
{
  "concessions": [
    {
      "id": "conv_123",
      "name": "Central Park Concession",
      "location": "New York, NY"
    },
    {
      "id": "conv_456",
      "name": "Golden Gate Park Concession",
      "location": "San Francisco, CA"
    }
  ]
}
```

--------------------------------

### POST /v1/leases/

Source: https://docs.propexo.com/api-reference/api-reference/leases/create-lease

Creates a new lease for an integration, allowing for the setup of lease terms, tenant information, and associated charges.

```APIDOC
## POST /v1/leases/

### Description
Creates a new lease for an integration. This endpoint allows for the creation of various lease types, including fixed-term, rollover, and at-will leases, and supports detailed configuration of rent, move-in dates, tenant information, and recurring charges.

### Method
POST

### Endpoint
/v1/leases/

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Bearer authentication of the form `Bearer <token>`, where token is your auth token.

#### Request Body
- **lease_type** (string) - Required - Type of lease. Enum: `Fixed`, `FixedWithRollover`, `AtWill`.
- **start_date** (string) - Required - The start date of the lease. Format: `date-time` or string.
- **end_date** (string) - Optional - The end date of the lease. Format: `date-time` or string.
- **country** (string) - Optional - The country for the lease. Enum: `US`.
- **rent_cycle** (string) - Required - The rent payment cycle. Enum: `Monthly`, `Weekly`, `Every2Weeks`, `Quarterly`, `Yearly`, `Every2Months`, `Daily`, `Every6Months`, `OneTime`.
- **rent_due_day** (integer) - Optional - The day of the month rent is due.
- **scheduled_move_in_date** (string) - Optional - The scheduled move-in date. Format: `date-time` or string.
- **tenants** (array of objects) - Optional - List of tenant objects.
  - **id** (string) - Required - Tenant's unique identifier.
- **resident_charges** (array of objects) - Optional - List of resident charges.
  - **financial_account_id** (string) - Required - The financial account ID for the charge.
  - **post_date** (string) - Required - The date the charge is posted. Format: `date-time` or string.
  - **description** (string) - Required - Description of the charge.
  - **amount_in_cents** (integer) - Required - The amount of the charge in cents.
  - **is_prorated** (boolean) - Required - Indicates if the charge is prorated.
- **recurring_resident_charges** (array of objects) - Optional - List of recurring resident charges.
  - **financial_account_id** (string) - Required - The financial account ID for the recurring charge.
  - **start_date** (string) - Required - The start date for the recurring charge. Format: `date-time` or string.
  - **end_date** (string) - Optional - The end date for the recurring charge. Format: `date-time` or string.
  - **description** (string) - Required - Description of the recurring charge.
  - **amount_in_cents** (integer) - Required - The amount of the recurring charge in cents.
  - **charge_due_day** (integer) - Required - The day of the month the recurring charge is due.
  - **frequency_raw** (integer) - Required - The frequency of the recurring charge in days.
- **status** (string) - Optional - The status of the lease. Enum: `PENDING`, `APPROVED`, `CANCELED`, `DENIED`, `SIGNED`.
- **other_occupants** (array of objects) - Optional - List of other occupants.
  - **relationship** (string) - Optional - Relationship to the primary tenant. Enum: `ROOMMATE`, `SPOUSE`, `GUARANTOR`, `OTHER`.
  - **phone1_type** (string) - Optional - Type of the first phone number. Enum: `FAX`, `HOME`, `MOBILE`, `WORK`.
  - **phone2_type** (string) - Optional - Type of the second phone number. Enum: `FAX`, `HOME`, `MOBILE`, `WORK`.

### Request Example
```json
{
  "lease_type": "Fixed",
  "start_date": "2024-01-01T00:00:00Z",
  "end_date": "2024-12-31T23:59:59Z",
  "country": "US",
  "rent_cycle": "Monthly",
  "rent_due_day": 1,
  "scheduled_move_in_date": "2024-01-01T00:00:00Z",
  "tenants": [
    {
      "id": "tenant_123"
    }
  ],
  "resident_charges": [
    {
      "financial_account_id": "fa_456",
      "post_date": "2024-01-01T00:00:00Z",
      "description": "Application Fee",
      "amount_in_cents": 5000,
      "is_prorated": false
    }
  ],
  "recurring_resident_charges": [
    {
      "financial_account_id": "fa_789",
      "start_date": "2024-01-01T00:00:00Z",
      "description": "Monthly Rent",
      "amount_in_cents": 150000,
      "charge_due_day": 1,
      "frequency_raw": 30
    }
  ],
  "status": "SIGNED"
}
```

### Response
#### Success Response (200)
- **lease_id** (string) - The unique identifier for the created lease.
- **message** (string) - A success message confirming lease creation.

#### Response Example
```json
{
  "lease_id": "lease_abc",
  "message": "Lease created successfully."
}
```

#### Error Response (400)
- **error** (string) - A message describing the bad request.

```

--------------------------------

### Next.js App Initialization and Chunk Loading (JavaScript)

Source: https://docs.propexo.com/api-reference/api-reference/admin/get-a-link-to-the-job-log-raw-request-and-response-data-of-a-write-job_explorer=true

These JavaScript snippets are part of the Next.js framework, responsible for bootstrapping the application and managing the loading of code chunks. They define how different parts of the application are fetched and initialized dynamically. No external dependencies are explicitly mentioned within these snippets, as they are integral to the Next.js runtime.

```javascript
self.__next_f.push([1,"69:[\"7578-90ad3a0c543bd012.js\",\"4253\",\"static/chunks/app/%5Bhost%5D/%5Bdomain%5D/layout-5955045344eddb36.js\"]],"SetFernUser"]

```

```javascript
self.__next_f.push([1,"5d:[\"$\",\"$L69\",null,{\"value\":\"$undefined\"}]

```

```javascript
self.__next_f.push([1,"6a:I[60530,[\"6374\",\"static/chunks/6374-101aec024e98ce81.js\",\"4666\",\"static/chunks/4666-4d85c672b7f55f54.js\",\"6852\",\"static/chunks/6852-742920f9c0c25c41.js\",\"290\",\"static/chunks/290-be3031372cf4c1fc.js\",\"6091\",\"static/chunks/6091-2a556250b7d22abf.js\",\"2965\",\"static/chunks/2965-5cf10eca88fff6c6.js\",\"1127\",\"static/chunks/1127-a12bf4fbeeafc03b.js\",\"4689\",\"static/chunks/4689-8e56d63892a25ec7.js\",\"8446\",\"static/chunks/8446-a788631978a426d3.js\",\"6196\",\"static/chunks/6196-e364d2d654a83da9.js\",\"9428\",\"static/chunks/9428-90f82b7ae6e7e8b7.js\",\"6723\",\"static/chunks/6723-bde8dc1a6dae0aa0.js\",\"6051\",\"static/chunks/6051-683bfd1efc4e6480.js\",\"9190\",\"static/chunks/9190-409cea03d1d632f5.js\",\"7473\",\"static/chunks/7473-190cfbae4dd0d64d.js\",\"8125\",\"static/chunks/8125-ff6f15b8dbede215.js\",\"3142\",\"static/chunks/3142-3235fb35bb942472.js\",\"3253\",\"static/chunks/3253-1adc6e78d84ce8e3.js\",\"158\",\"static/chunks/158-f057d70e809b271f.js\",\"1425\",\"static/chunks/1425-bd147a65082c4c3d.js\",\"2418\",\"static/chunks/2418-5ce628c4757514d5.js\",\"3834\",\"static/chunks/3834-409b67c561f7cd15.js\",\"8966\",\"static/chunks/8966-6e47dac5fe9842ab.js\",\"1319\",\"static/chunks/1319-c2de2c0b32399332.js\",\"7511\",\"static/chunks/7511-195adcdd50b2f281.js\",\"9002\",\"static/chunks/9002-3b90279f4b5791f1.js\",\"8152\",\"static/chunks/8152-16497bf4afa1034c.js\",\"7878\",\"static/chunks/7878-970c4d8be93b38c1.js\",\"5789\",\"static/chunks/5789-42c8b4afc3376d53.js\",\"3313\",\"static/chunks/3313-5c6dc5108d7d0a11.js\",\"4171\",\"static/chunks/app/%5Bhost%5D/%5Bdomain%5D/static/%5Bslug%5D/page-38ec206f321e5098.js\"],"PreloadChunks"]

```

```javascript
self.__next_f.push([1,"6b:I[42183,[\"5099\",\"static/chunks/0c1781ae-234a91147ef43c1b.js\",\"6374\",\"static/chunks/6374-101aec024e98ce81.js\",\"4666\",\"static/chunks/4666-4d85c672b7f55f54.js\",\"6852\",\"static/chunks/6852-742920f9c0c25c41.js\",\"290\",\"static/chunks/290-be3031372cf4c1fc.js\",\"6091\",\"static/chunks/6091-2a556250b7d22abf.js\",\"2965\",\"static/chunks/2965-5cf10eca88fff6c6.js\",\"1127\",\"static/chunks/1127-a12bf4fbeeafc03b.js\",\"4689\",\"static/chunks/4689-8e56d63892a25ec7.js\",\"8446\",\"static/chunks/8446-a788631978a426d3.js\",\"6196\",\"static/chunks/6196-e364d2d654a83da9.js\",\"9428\",\"static/chunks/9428-90f82b7ae6e7e8b7.js\",\"6723\",\"static/chunks/6723-bde8dc1a6dae0aa0.js\",\"6051\",\"static/chunks/6051-683bfd1efc4e6480.js\",\"9190\",\"static/chunks/9190-409cea03d1d632f5.js\",\"7473\",\"static/chunks/7473-190cfbae4dd0d64d.js\",\"4187\",\"static/chunks/4187-56262bcd9eac95d4.js\",\"8125\",\"static/chunks/8125-ff6f15b8dbede215.js\",\"3142\",\"static/chunks/3142-3235fb35bb942472.js\",\"3253\",\"static/chunks/3253-1adc6e78d84ce8e3.js\",\"158\",\"static/chunks/158-f057d70e809b271f.js\",\"723\",\"static/chunks/723-0ab3aad5d628fd7f.js\",\"853\",\"static/chunks/853-62fef8efedd388a2.js\",\"6258\",\"static/chunks/6258-3458b050b4ec9b62.js\",\"1439\",\"static/chunks/1439-5733e5951ba79ecb.js\",\"2418\",\"static/chunks/2418-5ce628c4757514d5.js\",\"1319\",\"static/chunks/1319-c2de2c0b32399332.js\",\"7511\",\"static/chunks/7511-195adcdd50b2f281.js\",\"9002\",\"static/chunks/9002-3b90279f4b5791f1.js\",\"8152\",\"static/chunks/8152-16497bf4afa1034c.js\",\"7878\",\"static/chunks/7878-970c4d8be93b38c1.js\",\"7578\",\"static/chunks/7578-90ad3a0c543bd012.js\",\"8432\",\"static/chunks/8432-2cf812854e59a11f.js\",\"5078\",\"static/chunks/app/%5Bhost%5D/%5Bdomain%5D/static/layout-c48b8b863fc21df3.js\"],"default"]

```

```javascript
self.__next_f.push([1,"6c:I[4018,[\"5099\",\"static/chunks/0c1781ae-234a91147ef43c1b.js\",\"6374\",\"static/chunks/6374-101aec024e98ce81.js\",\"4666\",\"static/chunks/4666-4d85c672b7f55f54.js\",\"6852\",\"static/chunks/6852-742920f9c0c25c41.js\",\"290\",\"static/chunks/290-be3031372cf4c1fc.js\",\"6091\",\"static/chunks/6091-2a556250b7d22abf.js\",\"2965\",\"static/chunks/2965-5cf10eca88fff6c6.js\",\"1127\",\"static/chunks/1127-a12bf4fbeeafc03b.js\",\"4689\",\"static/chunks/4689-8e56d63892a25ec7.js\",\"8446\",\"static/chunks/8446-a788631978a426d3.js\",\"6196\",\"static/chunks/6196-e364d2d654a83da9.js\",\"9428\",\"static/chunks/9428-90f82b7ae6e7e8b7.js\",\"6723\",\"static/chunks/6723-bde8dc1a6dae0aa0.js\",\"6051\",\"static/chunks/6051-683bfd1efc4e6480.js\",\"9190\",\"static/chunks/9190-409cea03d1d632f5.js\",\"7473\",\"static/chunks/7473-190cfbae4dd0d64d.js\",\"4187\",\"static/chunks/4187-56262bcd9eac95d4.js\",\"8125\",\"static/chunks/8125-ff6f15b8dbede215.js\",\"3142\",\"static/chunks/3142-3235fb35bb942472.js\",\"3253\",\"static/chunks/3253-1adc6e78d84ce8e3.js\",\"158\",\"static/chunks/158-f057d70e809b271f.js\",\"723\",\"static/chunks/7
```

--------------------------------

### GET /websites/propexo/applicants

Source: https://docs.propexo.com/api-reference/api-reference/applicants/get-all-applicants

Retrieves a list of applicants with associated metadata.

```APIDOC
## GET /websites/propexo/applicants

### Description
Retrieves a list of applicants, including their personal details, contact information, and any associated screening or custom data. The response includes metadata about the pagination and total results.

### Method
GET

### Endpoint
/websites/propexo/applicants

### Parameters

#### Query Parameters

* **limit** (integer) - Optional - The maximum number of results to return.
* **offset** (integer) - Optional - The number of results to skip.

### Request Example

```bash
GET /websites/propexo/applicants?limit=10&offset=0
```

### Response

#### Success Response (200)
- **meta** (object) - Metadata about the response, including pagination details.
- **results** (array) - An array of applicant objects.

##### Applicant Object Structure
- **id** (string) - The unique identifier for the applicant.
- **created_at** (string) - The timestamp when the applicant was created.
- **updated_at** (string) - The timestamp when the applicant was last updated.
- **last_seen** (string) - The timestamp of the last interaction with the applicant.
- **x_id** (string) - An internal identifier.
- **x_property_id** (string) - The ID of the associated property.
- **x_unit_id** (string) - The ID of the associated unit.
- **x_lease_id** (string) - The ID of the associated lease.
- **x_lead_id** (string) - The ID of the associated lead.
- **x_unit_id_preferred** (array) - A list of preferred unit IDs.
- **address_1_alternate** (string) - Alternate first address line.
- **address_1** (string) - First address line.
- **address_2_alternate** (string) - Alternate second address line.
- **address_2** (string) - Second address line.
- **applications** (array) - List of applications associated with the applicant.
- **city_alternate** (string) - Alternate city name.
- **city** (string) - City name.
- **country_alternate** (string) - Alternate country name.
- **country** (string) - Country name.
- **custom_data** (object or null) - Custom data fields for the applicant.
- **date_of_birth** (string or null) - The applicant's date of birth.
- **email_1** (string or null) - The applicant's primary email address.
- **email_2** (string or null) - The applicant's secondary email address.
- **first_name** (string or null) - The applicant's first name.
- **last_name** (string or null) - The applicant's last name.
- **middle_name** (string or null) - The applicant's middle name.
- **notes** (string or null) - Any notes related to the applicant.
- **phone_1_type** (object) - Type of the first phone number.
- **phone_1** (string or null) - The applicant's primary phone number.
- **phone_2_type** (object) - Type of the second phone number.
- **phone_2** (string or null) - The applicant's secondary phone number.
- **state_alternate** (string) - Alternate state name.
- **state** (string) - State name.
- **type_normalized** (string or null) - Normalized applicant type.
- **type_raw** (string or null) - Raw applicant type.
- **zip_alternate** (string) - Alternate zip code.
- **zip** (string) - Zip code.
- **pets** (array) - List of pets owned by the applicant.
- **integration_id** (string) - The ID from the integration system.
- **integration_vendor** (object) - The vendor of the integration.
- **property_id** (string) - The ID of the property.
- **unit_id_preferred** (array) - Preferred unit IDs.
- **screenings** (array) - List of screenings performed for the applicant.

#### Response Example

```json
{
  "meta": {
    "count": 10,
    "limit": 10,
    "offset": 0,
    "next": null,
    "previous": null
  },
  "results": [
    {
      "id": "applicant_123",
      "created_at": "2023-10-27T10:00:00Z",
      "updated_at": "2023-10-27T10:00:00Z",
      "last_seen": "2023-10-27T10:00:00Z",
      "x_id": "xid_abc",
      "x_property_id": "prop_456",
      "x_unit_id": "unit_789",
      "x_lease_id": "lease_012",
      "x_lead_id": "lead_345",
      "x_unit_id_preferred": ["unit_789", "unit_101"],
      "address_1_alternate": "Alt Addr 1",
      "address_1": "123 Main St",
      "address_2_alternate": "Alt Addr 2",
      "address_2": "Apt 4B",
      "applications": ["app_567"],
      "city_alternate": "Alt City",
      "city": "Anytown",
      "country_alternate": "Alt Country",
      "country": "USA",
      "custom_data": {},
      "date_of_birth": "1990-01-01",
      "email_1": "test@example.com",
      "email_2": null,
      "first_name": "John",
      "last_name": "Doe",
      "middle_name": "M",
      "notes": "Needs quiet unit.",
      "phone_1_type": {"name": "Mobile"},
      "phone_1": "555-123-4567",
      "phone_2_type": null,
      "phone_2": null,
      "state_alternate": "Alt State",
      "state": "CA",
      "type_normalized": "Renter",
      "type_raw": "Renter",
      "zip_alternate": "Alt Zip",
      "zip": "90210",
      "pets": [],
      "integration_id": "int_xyz",
      "integration_vendor": {"name": "VendorA"},
      "property_id": "prop_456",
      "unit_id_preferred": ["unit_789"],
      "screenings": []
    }
  ]
}
```
```
Tokens:
Raw