> 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 custom enum mappings for normalizing PMS-specific field values

GET https://api.propexo.com/v1/admin/normalization/{model}/{field}

Retrieves the custom enum mappings that normalize PMS-specific enum values to standardized Propexo values. These mappings can be user-customized per integration or use default system mappings. 

Valid model/field combinations (use these exact values for the model and field route parameters):
- leases/status → Maps PMS-specific lease status values to normalized lease statuses. Normalized values are returned in the leases.status_normalized response field. Possible normalized values: ACTIVE, INACTIVE, OTHER, PENDING, EVICTED
- residents/type → Maps PMS-specific resident type values to normalized resident types. Normalized values are returned in the residents.leases_meta_data[].resident_type_normalized response field. Possible normalized values: PRIMARY, SECONDARY, GUARANTOR, OTHER
- billing/payment-method → Maps PMS-specific payment method values to normalized payment methods. Normalized values are returned in the transactions.payment_method_normalized response field. Possible normalized values: CASH, CASHIERCHECK, CHECK, CREDITCARD, MONEYORDER, DIRECTDEPOSIT, ELECTRONICPAYMENT, OTHER
- properties/type → Maps PMS-specific property type values to normalized property types. Normalized values are returned in the properties.type_normalized response field. Possible normalized values: SINGLE_FAMILY, MULTI_FAMILY, STUDENT_HOUSING, VACATION, COMMERCIAL, OTHER
- applicants/status → Maps PMS-specific applicant status values to normalized applicant statuses. Normalized values are returned in the applicants.status_normalized response field. Possible normalized values: APPROVED, DENIED, CANCELED, OTHER, PENDING
- applicants/type → Maps PMS-specific applicant type values to normalized applicant types. Normalized values are returned in the applicants.type_normalized response field. Possible normalized values: GUARANTOR, OTHER, PRIMARY, SECONDARY

Custom enum mappings allow user-configurable normalization of PMS-specific enum values to standardized Propexo values.

Reference: https://docs.propexo.com/api-reference/configuration-ap-is/admin/get-custom-enum-mappings-for-normalizing-pms-specific-field-values

## 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

- `model` (string, required) — The model name (route parameter). Must be one of: leases, residents, billing, properties, or applicants. See the endpoint description for valid model/field combinations.
- `field` (string, required) — The field name within the model (route parameter). Valid fields depend on the model: leases/status, applicants/status, applicants/type, residents/type, properties/type, billing/payment-method. This is the mapping name and never carries the "_normalized" suffix used by response fields. Use "status" rather than "status_normalized" for leases. See the endpoint description for all valid model/field combinations.

### Query parameters

- `integration_id` (string, optional) — The ID of the integration for which to retrieve custom mappings. If provided, returns integration-specific custom mappings (if they exist). If omitted, returns the default system mappings for the vendor.
- `integration_vendor` (enum, required)
  - Allowed values: `APPFOLIO`, `BUILDIUM`, `ENTRATA`, `MRI`, `PROPERTYWARE`, `PROPERTYWARE_REST`, `REALPAGE`, `REALPAGE_RPX`, `RENTMANAGER`, `RENTVINE`, `RESMAN`, `YARDI`, `YARDI_REST`

## Response

### 200

Successful response

- `results` (V1AdminNormalizationModelFieldGetOutputResults, required)

## Errors

### 400 Bad Request Error

Bad Request

- `error` (ErrorResponseError, required)

## Types

### V1AdminNormalizationModelFieldGetOutputResults

- `is_custom_mapping` (boolean, required) — Whether the mapping has been customized by the user for this specific integration. If true, these are custom user-defined mappings. If false, these are the default system mappings provided by Propexo.
- `mappings` (map from string to string, required) — Key-value pairs mapping PMS-specific raw values (keys) to normalized Propexo values (values). For example, for lease\_status: \{"current": "ACTIVE", "former": "INACTIVE", "future": "PENDING"}. These mappings are applied when data is synced from the PMS to normalize enum values to Propexo standards.
- `default_value` (string, required) — The default normalized value to use when a PMS value does not match any key in the mappings. This ensures all values can be normalized even if they are not explicitly mapped. Typically set to values like "OTHER" for catch-all cases.

### ErrorResponseError

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

## Examples

**Response**

```json
{
  "results": {
    "is_custom_mapping": true,
    "mappings": {},
    "default_value": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.propexo.com/v1/admin/normalization/model/field"

querystring = {"integration_vendor":"APPFOLIO"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.propexo.com/v1/admin/normalization/model/field?integration_vendor=APPFOLIO';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.propexo.com/v1/admin/normalization/model/field?integration_vendor=APPFOLIO"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/admin/normalization/model/field?integration_vendor=APPFOLIO")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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/admin/normalization/model/field?integration_vendor=APPFOLIO")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.propexo.com/v1/admin/normalization/model/field?integration_vendor=APPFOLIO', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.propexo.com/v1/admin/normalization/model/field?integration_vendor=APPFOLIO");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/admin/normalization/model/field?integration_vendor=APPFOLIO")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```