WHOX APIs · API directory · Agent guide

warematch API

Full OpenAPI3.1 schema · Input and output JSON schemas · Usage documentation

Anonymous public reads. GET query parameters or POST JSON; both invoke the same read-only operation.

Service guide

All 11 marketplace filter groups are supported: Space Requirements, Amenities, Value-Add Services, Freight Services, Fulfillment Type, Retail Integrations, Temperature Control, Certifications, Technologies, Industry Specialization, Partners.

Quick filters are search parameter recipes:
{
  "rail_sided": {
    "is_rail_sided": true
  },
  "shopify": {
    "technologies": "8b1a9424-e326-4a60-903f-9f424f5af7d6"
  },
  "amazon_fba": {
    "fulfillment": "267e3805-5b4a-4de7-aacc-b4e567612765"
  },
  "tiktok_shop": {
    "fulfillment": "e40b9449-dfe3-4138-9364-8a81e40d958f"
  }
}

Call GET /v1/search or POST /v1/search with a JSON object. Example radius search: {"lat":40.6023,"lng":-75.4714,"radius":50,"is_map":false,"temperature_controlled":"0ae0cba5-61df-46a3-8292-95e3641e7ca6"}. Radius uses the source geographic-distance search, not road mileage or drive time. Never describe a location-text result as within a radius without using these geographic arguments.

Use the live lookup endpoints before selecting IDs. Combine groups freely. Each strict_* flag defaults to true (ALL values within that group); false means ANY. Keep filter arguments when incrementing page. Source next/previous links are upstream URLs, not WHOX URLs. The current source lists 565 public warehouse records; that number changes over time.

Example: curl --get 'https://warematch.api.whox.ai/v1/search' --data-urlencode 'location=Allentown'
Example: curl 'https://warematch.api.whox.ai/v1/temperature-controls'
Full filter snapshot: /filters.json. The endpoint lookups return live source data (30-second cache). Partner results use profile.id as the filter value; top-level company IDs will not match.

Only public marketplace reads are exposed. Warematch login-only details, quoting, bookings and account actions are outside this API. Listings, capabilities, capacity and pricing are source-reported; missing fields remain null. Source changes and rate limits can affect availability. Captured 2026-11-07T19:09:12.590Z.

search

Search public 3PL warehouse listings using all marketplace filters. Choose option UUIDs using the lookup operations. Returns count, results and source pagination links. Pagination links point upstream: continue here by incrementing page. Location text alone is not a distance search; use lat/lng/radius/is_map=false for proximity.

GET https://warematch.api.whox.ai/v1/search
ArgumentTypeRequiredDescription
pagenumberNoPage number (whole number).
page_sizenumberNoResults per page (whole number), maximum50.
locationstringNoLocation text as used by the Browse Location search, for example Allentown.
countrystringNoFull country name, for example United States or Canada. Two-letter codes such as US do not match the source.
statestringNoFull state/province name, for example Pennsylvania.
citystringNoCity name, for example Allentown.
latnumberNoSearch center latitude; supply with lng and radius for proximity search.
lngnumberNoSearch center longitude.
radiusnumberNoSource radius in miles; supply lat and lng and is_map=false.
is_mapbooleanNoUse false for radius searches, matching the site request.
is_initialbooleanNoSource initial geographic-search flag.
nearby_statesstringNoComma-separated full nearby state names; uses source geographic matching.
southnumberNoMap viewport south latitude.
northnumberNoMap viewport north latitude.
westnumberNoMap viewport west longitude.
eastnumberNoMap viewport east longitude.
square_footage_minnumberNoMinimum SQFT required.
square_footage_maxnumberNoMaximum SQFT (also supported by the site request builder).
pallets_minnumberNoMinimum pallet positions required.
amenitiesstringNoAmenities filter. Comma-separated option UUIDs; obtain IDs from the corresponding lookup operation.
servicesstringNoValue-Add Services filter. Comma-separated option UUIDs; obtain IDs from the corresponding lookup operation.
freight_servicesstringNoFreight Services filter. Comma-separated option UUIDs; obtain IDs from the corresponding lookup operation.
fulfillmentstringNoFulfillment Type filter; includes Amazon FBA and TikTok Shop. Comma-separated option UUIDs; obtain IDs from the corresponding lookup operation.
retail_integrationsstringNoRetail Integrations filter. Comma-separated option UUIDs; obtain IDs from the corresponding lookup operation.
temperature_controlledstringNoTemperature Control filter; Ambient, Frozen, Refrigerated. Comma-separated option UUIDs; obtain IDs from the corresponding lookup operation.
storage_conditionstringNoCertifications filter (the upstream parameter is named storage_condition). Comma-separated option UUIDs; obtain IDs from the corresponding lookup operation.
technologiesstringNoTechnologies filter; includes Shopify. Comma-separated option UUIDs; obtain IDs from the corresponding lookup operation.
specialized_category_idstringNoIndustry category UUID from industries.category_id.
specialized_product_idstringNoIndustry product specialization; IDs from industries.product_options[].id. Comma-separated option UUIDs; obtain IDs from the corresponding lookup operation.
whitelabel_idsstringNoPartners filter. Use partners.results[].profile.id, not the top-level company id. Comma-separated option UUIDs; obtain IDs from the corresponding lookup operation.
is_rail_sidedbooleanNoRail Sided quick filter.
strict_servicebooleanNoTrue requires ALL selected values in this group; false matches ANY. Defaults to true in the website.
strict_freightbooleanNoTrue requires ALL selected values in this group; false matches ANY. Defaults to true in the website.
strict_fulfillmentbooleanNoTrue requires ALL selected values in this group; false matches ANY. Defaults to true in the website.
strict_retailbooleanNoTrue requires ALL selected values in this group; false matches ANY. Defaults to true in the website.
strict_tempbooleanNoTrue requires ALL selected values in this group; false matches ANY. Defaults to true in the website.
strict_certbooleanNoTrue requires ALL selected values in this group; false matches ANY. Defaults to true in the website.
strict_techbooleanNoTrue requires ALL selected values in this group; false matches ANY. Defaults to true in the website.
strict_specializedbooleanNoTrue requires ALL selected values in this group; false matches ANY. Defaults to true in the website.
strict_amenitybooleanNoTrue requires ALL selected values in this group; false matches ANY. Defaults to true in the website.
get_premiumbooleanNoPremium-listing flag supported by the source request builder.
price_per_standard_pallet_stackable_per_month_maxnumberNoMaximum standard stackable pallet price per month; source request builder price parameter.

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number"
        },
        "next": {
          "type": "string"
        },
        "previous": {
          "description": "Nullable upstream field; may be populated on other records."
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "uq_slug": {
                "type": "string"
              },
              "location": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "province": {
                "type": "string"
              },
              "product_types": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "listing_type": {
                "type": "string"
              },
              "available_square_footage": {
                "type": "number"
              },
              "available_pallets": {
                "description": "Nullable upstream field; may be populated on other records."
              },
              "availability": {
                "type": "boolean"
              },
              "approved": {
                "type": "boolean"
              },
              "currency": {
                "type": "string"
              },
              "pricing_type": {
                "description": "Nullable upstream field; may be populated on other records."
              },
              "price_per_cubic_foot_per_month": {
                "description": "Nullable upstream field; may be populated on other records."
              },
              "sublease_per_sqft_price": {
                "description": "Nullable upstream field; may be populated on other records."
              },
              "price_per_square_footage_per_month": {
                "description": "Nullable upstream field; may be populated on other records."
              },
              "display_price": {
                "type": "string"
              },
              "display_image": {
                "type": "string"
              },
              "lat": {
                "type": "number"
              },
              "lng": {
                "type": "number"
              },
              "distance_miles": {
                "description": "Nullable upstream field; may be populated on other records."
              },
              "images": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "file": {
                      "type": "string"
                    },
                    "url": {
                      "type": "string"
                    },
                    "file_type": {
                      "type": "string"
                    },
                    "category": {
                      "type": "string"
                    },
                    "uploaded_at": {
                      "type": "string"
                    },
                    "order": {
                      "type": "number"
                    }
                  },
                  "additionalProperties": true
                }
              },
              "storage_conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "icon": {
                      "description": "Nullable upstream field; may be populated on other records."
                    },
                    "ordering_index": {
                      "type": "number"
                    }
                  },
                  "additionalProperties": true
                }
              },
              "reviews": {
                "type": "object",
                "properties": {
                  "average_rating": {
                    "type": "number"
                  },
                  "num_reviews": {
                    "type": "number"
                  }
                },
                "additionalProperties": true
              },
              "display_value": {
                "type": "string"
              },
              "specialized_products_grouped": {
                "type": "array",
                "items": {}
              },
              "other_specialized_products": {
                "description": "Nullable upstream field; may be populated on other records."
              },
              "other_storage_conditions": {
                "description": "Nullable upstream field; may be populated on other records."
              },
              "is_featured": {
                "type": "boolean"
              },
              "is_premium": {
                "type": "object",
                "properties": {
                  "whitelabel_listing": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "uq_slug": {
                        "type": "string"
                      },
                      "slug": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  },
                  "whitelabel_profile": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "slug": {
                        "type": "string"
                      },
                      "logo_url": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  },
                  "google_review": {
                    "description": "Nullable upstream field; may be populated on other records."
                  }
                },
                "additionalProperties": true
              },
              "warehouse_preferred_clients": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "preferred_client": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "icon": {
                          "description": "Nullable upstream field; may be populated on other records."
                        },
                        "description": {
                          "type": "string"
                        },
                        "order": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": true
                    },
                    "description": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true
                }
              },
              "retail_integrations": {
                "type": "array",
                "items": {}
              },
              "other_retail_integrations": {
                "description": "Nullable upstream field; may be populated on other records."
              },
              "specialized_products_new": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "category": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "slug": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    },
                    "name": {
                      "type": "string"
                    },
                    "slug": {
                      "type": "string"
                    },
                    "description": {
                      "description": "Nullable upstream field; may be populated on other records."
                    },
                    "icon": {
                      "description": "Nullable upstream field; may be populated on other records."
                    },
                    "display_order": {
                      "type": "number"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "metadata": {
                      "description": "Nullable upstream field; may be populated on other records."
                    },
                    "industry_page_url": {
                      "description": "Nullable upstream field; may be populated on other records."
                    }
                  },
                  "additionalProperties": true
                }
              },
              "temperature_control": {
                "type": "array",
                "items": {}
              },
              "services": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "asssociated_price_feild": {
                      "type": "string"
                    },
                    "associated_description_feild": {
                      "type": "string"
                    },
                    "ordering_index": {
                      "type": "number"
                    }
                  },
                  "additionalProperties": true
                }
              },
              "total_square_footage": {
                "type": "number"
              },
              "total_pallets": {
                "description": "Nullable upstream field; may be populated on other records."
              },
              "has_wms": {
                "type": "boolean"
              },
              "order": {
                "type": "number"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

amenities

Get every currently available Amenities filter option with its source ID.

GET https://warematch.api.whox.ai/v1/amenities
ArgumentTypeRequiredDescription

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

services

Get every currently available Value-Add Services filter option with its source ID.

GET https://warematch.api.whox.ai/v1/services
ArgumentTypeRequiredDescription

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "asssociated_price_feild": {
            "type": "string"
          },
          "associated_description_feild": {
            "type": "string"
          },
          "ordering_index": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

freight-services

Get every currently available Freight Services filter option with its source ID.

GET https://warematch.api.whox.ai/v1/freight-services
ArgumentTypeRequiredDescription

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "asssociated_price_feild": {
            "type": "string"
          },
          "associated_description_feild": {
            "type": "string"
          },
          "ordering_index": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

fulfillment-types

Get every currently available Fulfillment Type filter option with its source ID.

GET https://warematch.api.whox.ai/v1/fulfillment-types
ArgumentTypeRequiredDescription

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "icon": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "order": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

retail-integrations

Get every currently available Retail Integrations filter option with its source ID.

GET https://warematch.api.whox.ai/v1/retail-integrations
ArgumentTypeRequiredDescription

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "category_order": {
            "type": "number"
          },
          "region": {
            "type": "string"
          },
          "logo": {
            "description": "Nullable upstream field; may be populated on other records."
          },
          "icon": {
            "description": "Nullable upstream field; may be populated on other records."
          },
          "brand_color": {
            "type": "string"
          },
          "display_order": {
            "type": "number"
          },
          "is_other": {
            "type": "boolean"
          }
        },
        "additionalProperties": true
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

temperature-controls

Get every currently available Temperature Control filter option with its source ID.

GET https://warematch.api.whox.ai/v1/temperature-controls
ArgumentTypeRequiredDescription

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "icon": {
            "description": "Nullable upstream field; may be populated on other records."
          },
          "description": {
            "type": "string"
          },
          "maximum_temperature": {
            "type": "string"
          },
          "minimum_temperature": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

certifications

Get every currently available Certifications filter option with its source ID.

GET https://warematch.api.whox.ai/v1/certifications
ArgumentTypeRequiredDescription

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "icon": {
            "description": "Nullable upstream field; may be populated on other records."
          },
          "ordering_index": {
            "type": "number"
          }
        },
        "additionalProperties": true
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

technologies

Get every currently available Technologies (grouped by category) filter option with its source ID.

GET https://warematch.api.whox.ai/v1/technologies
ArgumentTypeRequiredDescription

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string"
          },
          "softwares": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "icon": {
                  "description": "Nullable upstream field; may be populated on other records."
                },
                "category": {
                  "type": "string"
                }
              },
              "additionalProperties": true
            }
          }
        },
        "additionalProperties": true
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

industries

Get every currently available Industry Specialization (categories and products) filter option with its source ID.

GET https://warematch.api.whox.ai/v1/industries
ArgumentTypeRequiredDescription

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "category_group": {
            "type": "string"
          },
          "category_id": {
            "type": "string"
          },
          "category_slug": {
            "type": "string"
          },
          "icon": {
            "description": "Nullable upstream field; may be populated on other records."
          },
          "product_options": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "slug": {
                  "type": "string"
                },
                "icon": {
                  "description": "Nullable upstream field; may be populated on other records."
                },
                "description": {
                  "description": "Nullable upstream field; may be populated on other records."
                },
                "industry_page_url": {
                  "description": "Nullable upstream field; may be populated on other records."
                }
              },
              "additionalProperties": true
            }
          }
        },
        "additionalProperties": true
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

partners

Get/search paginated partner companies. For search.whitelabel_ids use each company.profile.id.

GET https://warematch.api.whox.ai/v1/partners
ArgumentTypeRequiredDescription
pagenumberNoPartner lookup page.
searchstringNoSearch partner company names.

Try this read operation

Response schema

{
  "type": "object",
  "required": [
    "ok",
    "service",
    "operation",
    "data",
    "meta"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "service": {
      "type": "string"
    },
    "operation": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number"
        },
        "next": {
          "type": "string"
        },
        "previous": {
          "description": "Nullable upstream field; may be populated on other records."
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "uq_slug": {
                "type": "string"
              },
              "profile": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "description": "Nullable upstream field; may be populated on other records."
                  },
                  "phone": {
                    "description": "Nullable upstream field; may be populated on other records."
                  },
                  "slug": {
                    "type": "string"
                  },
                  "logo": {
                    "type": "string"
                  },
                  "account_id": {
                    "type": "string"
                  },
                  "created_at": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              },
              "company_name": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "phone": {
                "type": "string"
              },
              "template": {
                "type": "string"
              },
              "created_at": {
                "type": "string"
              },
              "section_subtitles": {
                "type": "object",
                "properties": {
                  "map_subtitle": {
                    "type": "string"
                  },
                  "stats_subtitle": {
                    "type": "string"
                  },
                  "awards_subtitle": {
                    "type": "string"
                  },
                  "contact_subtitle": {
                    "type": "string"
                  },
                  "services_subtitle": {
                    "type": "string"
                  },
                  "leadership_subtitle": {
                    "type": "string"
                  },
                  "why_choose_us_subtitle": {
                    "type": "string"
                  },
                  "certifications_subtitle": {
                    "type": "string"
                  },
                  "google_reviews_subtitle": {
                    "type": "string"
                  },
                  "company_carousel_subtitle": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              },
              "section_titles": {
                "type": "object",
                "properties": {
                  "map_title": {
                    "type": "string"
                  },
                  "stats_title": {
                    "type": "string"
                  },
                  "awards_title": {
                    "type": "string"
                  },
                  "contact_title": {
                    "type": "string"
                  },
                  "services_title": {
                    "type": "string"
                  },
                  "leadership_title": {
                    "type": "string"
                  },
                  "why_choose_us_title": {
                    "type": "string"
                  },
                  "certifications_title": {
                    "type": "string"
                  },
                  "google_reviews_title": {
                    "type": "string"
                  },
                  "company_carousel_title": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              },
              "logo_toggle": {
                "type": "boolean"
              },
              "is_live": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        },
        "logos": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": true
    },
    "meta": {
      "type": "object",
      "required": [
        "tier",
        "source",
        "durationMs",
        "cached"
      ],
      "properties": {
        "tier": {
          "const": 1
        },
        "source": {
          "type": "string",
          "format": "uri"
        },
        "durationMs": {
          "type": "number"
        },
        "cached": {
          "type": "boolean"
        },
        "ageMs": {
          "type": "number"
        },
        "definitionVersion": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": false
}

Limits:60 requests/minute/client; source limits also apply. Cache30seconds; timeout15seconds. Errors return JSON with a code and message, using400/404/429/502/503/504. API keys, cookies and WHOX account sessions are never shared.