---
updatedAt: 2026-01-19T13:33:43.000Z
agentTools:
  projectIndex: https://docs.cupid.travel/llms.txt
---

# List partner catalogs

This endpoint returns a paginated list of partner catalogs for the authenticated company. You can use query parameters to control pagination and sorting.

The response includes detailed information about each partner catalog, including mapping status, hotel counts, and catalog metadata.

To experiment this API call, use the following sandbox API key:

88cd7ff1-e3af-4377-a5b0-38a4b483e92f

# 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/partner-catalogs": {
      "get": {
        "tags": [
          "Hotel Mapping"
        ],
        "summary": "List partner catalogs",
        "description": "This endpoint returns a paginated list of partner catalogs for the authenticated company. You can use query parameters to control pagination and sorting.\n\nThe response includes detailed information about each partner catalog, including mapping status, hotel counts, and catalog metadata.\n\nTo experiment this API call, use the following sandbox API key:\n\n88cd7ff1-e3af-4377-a5b0-38a4b483e92f",
        "security": [
          {
            "apikeyAuth": []
          }
        ],
        "parameters": [
          {
            "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": "partnerId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1
            },
            "description": "Filter results by partner ID. If provided, only catalogs for the specified partner will be returned."
          },
          {
            "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)"
          }
        ],
        "responses": {
          "200": {
            "description": "List of partner catalogs returned successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 200,
                      "description": "Response code"
                    },
                    "data": {
                      "type": "array",
                      "description": "Array of partner catalog objects",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "description": "Partner catalog ID"
                          },
                          "total_hotels": {
                            "type": "integer",
                            "description": "Total number of hotels in the catalog"
                          },
                          "mapped_hotels": {
                            "type": "integer",
                            "description": "Number of successfully mapped hotels"
                          },
                          "unmapped_hotels": {
                            "type": "integer",
                            "description": "Number of unmapped hotels"
                          },
                          "valid_hotels": {
                            "type": "integer",
                            "description": "Number of valid hotels"
                          },
                          "new_hotels": {
                            "type": "integer",
                            "description": "Number of new hotels"
                          },
                          "invalid_hotels": {
                            "type": "integer",
                            "description": "Number of invalid hotels"
                          },
                          "name": {
                            "type": "string",
                            "description": "Catalog name"
                          },
                          "action": {
                            "type": "string",
                            "description": "Catalog action (e.g., 'add', 'update')"
                          },
                          "active": {
                            "type": "boolean",
                            "description": "Whether the catalog is active"
                          },
                          "outdated": {
                            "type": "boolean",
                            "description": "Whether the catalog is outdated"
                          },
                          "has_mapping_error": {
                            "type": "boolean",
                            "description": "Whether the catalog has mapping errors"
                          },
                          "partner_id": {
                            "type": "integer",
                            "description": "Partner ID"
                          },
                          "partner_name": {
                            "type": "string",
                            "description": "Partner name"
                          },
                          "mapping_process_status_id": {
                            "type": "integer",
                            "description": "Mapping process status ID (-1: Invalid, 0: Pending, 1: Processing, 2: Done, 3: Failed)"
                          },
                          "company_id": {
                            "type": "integer",
                            "description": "Company ID"
                          },
                          "affiliate_id": {
                            "type": "integer",
                            "description": "Affiliate ID"
                          },
                          "inventory_id": {
                            "type": "integer",
                            "description": "Inventory ID"
                          },
                          "model": {
                            "type": "string",
                            "description": "Mapping model used"
                          },
                          "use_manual_mappings": {
                            "type": "boolean",
                            "description": "Whether manual mappings are used"
                          },
                          "created_at": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Catalog creation timestamp"
                          },
                          "updated_at": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Catalog last update timestamp"
                          },
                          "partner_inventory_id": {
                            "type": "integer",
                            "description": "Partner inventory ID"
                          }
                        }
                      }
                    },
                    "pagination": {
                      "type": "object",
                      "description": "Pagination information",
                      "properties": {
                        "total_elements": {
                          "type": "integer",
                          "description": "Total number of records matching the query"
                        },
                        "limit": {
                          "type": "integer",
                          "description": "Maximum number of records per page"
                        },
                        "offset": {
                          "type": "integer",
                          "description": "Number of records skipped"
                        },
                        "sort": {
                          "type": "object",
                          "description": "Sort configuration",
                          "properties": {
                            "column": {
                              "type": "string",
                              "description": "Column name used for sorting"
                            },
                            "order": {
                              "type": "string",
                              "description": "Sort order (ASC or DESC)"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - Missing or invalid API key",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Not authorized"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 500
                    },
                    "message": {
                      "type": "string",
                      "example": "An error occured while processing the request."
                    },
                    "msg": {
                      "type": "string",
                      "example": "Cannot fetch partner catalogs"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```