LayoffsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/jobspipe/json-schema/jobspipe-layoffs-response-schema.json",
  "title": "LayoffsResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/jobspipe-layoffs-api-openapi.yml#/components/schemas/LayoffsResponse",
  "type": "object",
  "required": [
    "data",
    "metadata"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/LayoffNotice"
      },
      "description": "Newest notice first."
    },
    "metadata": {
      "type": "object",
      "properties": {
        "total_results": {
          "type": "integer",
          "description": "Notices the filters match."
        },
        "returned_results": {
          "type": "integer"
        },
        "next_offset": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The offset of the next page; null on the last page."
        },
        "credits_charged": {
          "type": "integer"
        },
        "notices_already_paid": {
          "type": "integer",
          "description": "Notices on this page already paid for this calendar month, so free."
        },
        "credits_remaining": {
          "type": "integer",
          "description": "Credits the account can still spend after this call. Absent for callers that are not metered."
        },
        "credits_allowance": {
          "type": "integer",
          "description": "What credits_remaining is measured against: the monthly allowance, or Free's one-time grant."
        }
      }
    }
  },
  "$defs": {
    "LayoffNotice": {
      "type": "object",
      "required": [
        "id",
        "state",
        "employer",
        "address",
        "city",
        "county",
        "zip",
        "notice_date",
        "effective_date",
        "employees",
        "kind",
        "company"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The notice's id; stable when the state amends the notice."
        },
        "state": {
          "type": "string",
          "description": "Two-letter postal code of the state that published the notice."
        },
        "employer": {
          "type": "string",
          "description": "The employer as named on the notice."
        },
        "address": {
          "type": [
            "string",
            "null"
          ]
        },
        "city": {
          "type": [
            "string",
            "null"
          ]
        },
        "county": {
          "type": [
            "string",
            "null"
          ]
        },
        "zip": {
          "type": [
            "string",
            "null"
          ]
        },
        "notice_date": {
          "type": [
            "string",
            "null"
          ],
          "format": "date",
          "description": "The day the notice was given or received."
        },
        "effective_date": {
          "type": [
            "string",
            "null"
          ],
          "format": "date",
          "description": "The day the layoff or closure takes effect, when stated."
        },
        "employees": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Employees affected, when stated."
        },
        "kind": {
          "type": "string",
          "enum": [
            "layoff",
            "closure",
            "unknown"
          ],
          "description": "closure: the site or plant closes. unknown: the notice does not say."
        },
        "company": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string",
                  "description": "The company's key, for its company page or as company_key_or in job search."
                },
                "name": {
                  "type": "string"
                },
                "domain": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            },
            {
              "type": "null"
            }
          ],
          "description": "The company the notice names, when it is matched to the company with confidence; null otherwise."
        }
      }
    }
  }
}