---
updatedAt: 2026-01-27T15:04:18.000Z
agentTools:
  projectIndex: https://docs.cupid.travel/llms.txt
---

# Get unmapped properties

Returns a paginated list of unmapped hotel properties for the specified mapping. Includes the reason why each hotel was not mapped (e.g., no candidates found, multiple candidates, low confidence, etc.).

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Cupid Hotel Mapping API",
    "version": "3.0"
  },
  "security": [
    {
      "apikeyAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://api.cupid.travel"
    }
  ],
  "paths": {
    "/api/mapping/{id}/unmapped": {
      "get": {
        "tags": [
          "Hotel Mapping"
        ],
        "summary": "Get unmapped properties",
        "description": "Returns a paginated list of unmapped hotel properties for the specified mapping. Includes the reason why each hotel was not mapped (e.g., no candidates found, multiple candidates, low confidence, etc.).",
        "security": [
          {
            "apikeyAuth": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Mapping ID"
          },
          {
            "name": "x-api-key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "API key for authentication"
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0,
              "minimum": 0
            },
            "description": "Number of records to skip (for pagination)"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 10,
              "minimum": 1
            },
            "description": "Maximum number of records to return (for pagination)"
          },
          {
            "name": "sortColumn",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Column name to sort by"
          },
          {
            "name": "sortOrder",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "ASC",
                "DESC"
              ],
              "default": "ASC"
            },
            "description": "Sort order: ASC (ascending) or DESC (descending)"
          },
          {
            "name": "city",
            "in": "query",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Filter by city"
          },
          {
            "name": "country",
            "in": "query",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Filter by country"
          },
          {
            "name": "hotel_name",
            "in": "query",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Filter by hotel name"
          },
          {
            "name": "hotel_code",
            "in": "query",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Filter by hotel code"
          }
        ],
        "responses": {
          "200": {
            "description": "Unmapped properties retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 200,
                      "description": "Response code"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/UnmappedProperty"
                      },
                      "description": "Array of unmapped hotel properties"
                    },
                    "msg": {
                      "type": "string",
                      "example": "Unmapped properties retrieved successfully",
                      "description": "Success message"
                    },
                    "page": {
                      "type": "object",
                      "properties": {
                        "total": {
                          "type": "integer",
                          "format": "int64",
                          "description": "Total number of elements"
                        },
                        "offset": {
                          "type": "integer",
                          "description": "Number of records skipped"
                        },
                        "limit": {
                          "type": "integer",
                          "description": "Maximum number of records per page"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid mapping ID",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JSONBadRequestResult"
                }
              }
            }
          },
          "401": {
            "description": "Invalid company ID or unauthorized access",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JSONUnauthorizedErrorResult"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JSONServerErrorResult"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "UnmappedProperty": {
        "type": "object",
        "properties": {
          "hotel_code": {
            "type": "string",
            "description": "Hotel code"
          },
          "name": {
            "type": "string",
            "description": "Hotel name"
          },
          "address": {
            "type": "string",
            "description": "Hotel address"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "city_id": {
            "type": "string",
            "description": "City ID"
          },
          "country": {
            "type": "string",
            "description": "Country"
          },
          "latitude": {
            "type": "number",
            "description": "Latitude"
          },
          "longitude": {
            "type": "number",
            "description": "Longitude"
          },
          "chain": {
            "type": "string",
            "description": "Hotel chain"
          },
          "zip_code": {
            "type": "string",
            "description": "Zip code"
          },
          "stars": {
            "type": "number",
            "description": "Star rating"
          },
          "type": {
            "type": "string",
            "description": "Hotel type"
          },
          "unmapped_reason": {
            "type": "string",
            "enum": [
              "More than one candidate",
              "No candidates found",
              "Numbers mismatching",
              "Duplicated in partner catalog",
              "Not enough confidence"
            ],
            "description": "Reason why the hotel was not mapped"
          }
        }
      },
      "JSONBadRequestResult": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "example": 400
          },
          "msg": {
            "type": "string",
            "example": "Bad request"
          }
        }
      },
      "JSONUnauthorizedErrorResult": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "example": 401
          },
          "msg": {
            "type": "string",
            "example": "Unauthorized"
          }
        }
      },
      "JSONServerErrorResult": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "example": 500
          },
          "msg": {
            "type": "string",
            "example": "Internal server error"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```