CompanyListDocument

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/jobfinder-ai-com/json-schema/jobfinder-ai-com-company-list-document-schema.json",
  "title": "CompanyListDocument",
  "x-generated": "2026-11-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/jobfinder-ai-com-openapi.json#/components/schemas/CompanyListDocument",
  "type": "object",
  "required": [
    "apiVersion",
    "data",
    "meta"
  ],
  "properties": {
    "apiVersion": {
      "type": "string",
      "const": "1.0.0"
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Company"
      }
    },
    "meta": {
      "$ref": "#/$defs/ListMeta"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "Company": {
      "type": "object",
      "required": [
        "id",
        "type",
        "name",
        "domain",
        "logo",
        "activeJobCount",
        "directoryUrl"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable API id derived from the company name and public domain."
        },
        "type": {
          "type": "string",
          "const": "company"
        },
        "name": {
          "type": "string"
        },
        "domain": {
          "type": [
            "string",
            "null"
          ]
        },
        "logo": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "activeJobCount": {
          "type": "integer",
          "minimum": 1
        },
        "directoryUrl": {
          "type": "string",
          "format": "uri",
          "description": "Stable directory containing public company job listings; no collision-prone company-detail URL is implied."
        }
      },
      "additionalProperties": false
    },
    "ListMeta": {
      "type": "object",
      "required": [
        "count",
        "total",
        "hasMore",
        "nextCursor",
        "readOnly"
      ],
      "properties": {
        "count": {
          "type": "integer",
          "minimum": 0,
          "description": "Records returned on this page."
        },
        "total": {
          "type": "integer",
          "minimum": 0,
          "description": "Exact total for jobs; a lower bound for companies when totalIsLowerBound is true."
        },
        "totalIsLowerBound": {
          "type": "boolean",
          "description": "Whether total is a lower bound rather than an exact count."
        },
        "hasMore": {
          "type": "boolean"
        },
        "nextCursor": {
          "type": [
            "string",
            "null"
          ],
          "description": "Opaque continuation token or null on the final page."
        },
        "readOnly": {
          "type": "boolean",
          "const": true
        }
      },
      "additionalProperties": false
    }
  }
}