Company Directory by Category

{
  "type": "object",
  "required": [
    "slug"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number"
    },
    "slug": {
      "type": "string",
      "description": "Category slug from get_categories (e.g. 'bank', 'animals_pets', 'insurance_agency')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "companies": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Opaque internal business identifier on the upstream review platform (a 24-character hex string). Not a phone number or any other contact detail."
              },
              "name": {
                "type": "string",
                "description": "The company's public display name."
              },
              "stars": {
                "type": "number",
                "description": "0-5 star rating, observed in half-star increments."
              },
              "domain": {
                "type": "string",
                "description": "The company's registered domain, e.g. 'happen.com'."
              },
              "location": {
                "type": "object",
                "properties": {
                  "city": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "address": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "Street address as registered on the upstream platform, when on file."
                  },
                  "country": {
                    "type": "string",
                    "description": "'United States' on every entry observed."
                  },
                  "zipCode": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "description": "The company's registered business location on the upstream platform. `address`, `city`, and `zipCode` were all observed `null` together for several companies in both fixtures (location data is not always on file) -- treat every one of those fields as possibly absent, not guaranteed present.",
                "additionalProperties": true
              },
              "trust_score": {
                "type": "number",
                "description": "0-5 scale, observed with one decimal place."
              },
              "review_count": {
                "type": "integer"
              }
            },
            "additionalProperties": true
          },
          "description": "20 entries per page on both real calls observed; page size beyond 20 is unconfirmed."
        },
        "pagination": {
          "type": "object",
          "properties": {
            "per_page": {
              "type": "integer",
              "description": "20 on both real calls observed."
            },
            "total_hits": {
              "type": "integer",
              "description": "Total matching companies across all pages, not just this page."
            },
            "total_pages": {
              "type": "integer"
            }
          },
          "additionalProperties": true
        },
        "category_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Observed as `null` on both real populated calls (bank and insurance_agency) -- a human-readable category label was never actually returned; do not assume it is populated just because a category slug matched."
        }
      },
      "additionalProperties": true
    },
    "status": {
      "type": "string",
      "description": "'success' on both real populated calls observed."
    }
  },
  "description": "The category listing page, as returned at routing.responseResultPath ($.output) after shaping. Observed as an empty object (no `status`, no `data` key at all) when the requested category slug does not exist on the upstream platform (see examples/invalid-slug.json) -- that call still settles COMPLETED, but bills $0 (billedUnits 0) rather than the quoted per-call price. Check for a missing/falsy `data` key before reading `.data.companies`, not for the result being `null`.",
  "additionalProperties": true
}