{
  "openapi": "3.1.0",
  "info": {
    "title": "GreenHired API",
    "version": "1.0.0",
    "summary": "Read-only API for green jobs, categories and salary insights.",
    "description": "The GreenHired API v1 is read-only and needs an API key (an `Authorization: Bearer ghk_...` header, or `X-API-Key`). Keys have scopes and limits; every answer carries `X-RateLimit-*` headers.\n\nAttribution: every job has a `url` on greenhired.com. Show it next to what you display and link to it.\n\nSource terms: by default only jobs posted on GreenHired itself are served. `source_type` says where a job came from.\n\nv1 only ever grows: fields and endpoints may be added, never removed or changed in meaning. Breaking changes will be a new /v2."
  },
  "servers": [
    {
      "url": "https://api.greenhired.com/v1",
      "description": "Production"
    }
  ],
  "tags": [
    {
      "name": "Account"
    },
    {
      "name": "Jobs"
    },
    {
      "name": "Categories"
    },
    {
      "name": "Insights"
    }
  ],
  "paths": {
    "/categories": {
      "get": {
        "operationId": "listCategories",
        "tags": [
          "Categories"
        ],
        "summary": "List the green categories",
        "description": "The 28 green job categories with the number of live jobs in each. Only jobs that GreenHired may hand on are returned: by default the jobs posted on GreenHired itself. The counts can be up to a minute old.",
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          }
        ],
        "x-required-scope": "categories:read",
        "responses": {
          "200": {
            "description": "All categories.",
            "headers": {
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/X-RateLimit-Reset"
              },
              "X-RateLimit-Daily-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Daily-Limit"
              },
              "X-RateLimit-Daily-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Daily-Remaining"
              },
              "X-API-Version": {
                "$ref": "#/components/headers/X-API-Version"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CategoryList"
                },
                "example": {
                  "data": [
                    {
                      "slug": "renewable-energy",
                      "name": "Renewable Energy",
                      "sector": "Energy",
                      "description": "Solar, wind, hydro and geothermal roles.",
                      "open_jobs": 120
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "A parameter was sent (this endpoint takes none).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/Unavailable"
          }
        }
      }
    },
    "/insights/salaries": {
      "get": {
        "operationId": "getSalaryInsights",
        "tags": [
          "Insights"
        ],
        "summary": "Salary statistics",
        "description": "Yearly pay statistics per category and/or country, per currency, from the public jobs that state pay. Pay periods are converted to a year with fixed factors (hour 2080, day 260, week 52, month 12); a job with no known period is left out. A group with fewer than 5 jobs is not returned. Only jobs that GreenHired may hand on are returned: by default the jobs posted on GreenHired itself. The figures can be up to five minutes old.",
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          }
        ],
        "x-required-scope": "insights:read",
        "parameters": [
          {
            "name": "category",
            "in": "query",
            "required": false,
            "description": "Only jobs of these green categories. Send a comma list (a,b) or repeat the parameter. At most 28 values.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "maxItems": 28
            },
            "style": "form",
            "explode": false,
            "example": [
              "renewable-energy"
            ]
          },
          {
            "name": "country",
            "in": "query",
            "required": false,
            "description": "Only jobs in these countries. Send a comma list (a,b) or repeat the parameter. At most 5 values.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "maxItems": 5
            },
            "style": "form",
            "explode": false,
            "example": [
              "Germany"
            ]
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "description": "Only this currency.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z]{3}$"
            },
            "example": "EUR"
          },
          {
            "name": "group_by",
            "in": "query",
            "required": false,
            "description": "One figure set per category, per country, or per pair. Default category.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "category",
                  "country"
                ]
              },
              "maxItems": 2
            },
            "style": "form",
            "explode": false,
            "example": [
              "category"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "The groups with enough jobs (possibly none).",
            "headers": {
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/X-RateLimit-Reset"
              },
              "X-RateLimit-Daily-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Daily-Limit"
              },
              "X-RateLimit-Daily-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Daily-Remaining"
              },
              "X-API-Version": {
                "$ref": "#/components/headers/X-API-Version"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalaryInsightList"
                },
                "example": {
                  "data": [
                    {
                      "category": "renewable-energy",
                      "country": "Germany",
                      "currency": "EUR",
                      "period": "year",
                      "sample_size": 42,
                      "min": 38000,
                      "p25": 52000,
                      "median": 61000,
                      "p75": 72000,
                      "max": 110000
                    }
                  ],
                  "meta": {
                    "period": "year",
                    "min_sample_size": 5,
                    "group_by": [
                      "category"
                    ],
                    "truncated": false
                  }
                }
              }
            }
          },
          "400": {
            "description": "A parameter is not valid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/Unavailable"
          }
        }
      }
    },
    "/jobs": {
      "get": {
        "operationId": "listJobs",
        "tags": [
          "Jobs"
        ],
        "summary": "List jobs",
        "description": "Public jobs, newest first, with filters and cursor pagination. Only jobs that GreenHired may hand on are returned: by default the jobs posted on GreenHired itself. A job with no posting date is not listed. Free-text search (q) is not part of v1 yet.",
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          }
        ],
        "x-required-scope": "jobs:read",
        "parameters": [
          {
            "name": "category",
            "in": "query",
            "required": false,
            "description": "Green category slugs, from /v1/categories. Send a comma list (a,b) or repeat the parameter. At most 28 values.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "maxItems": 28
            },
            "style": "form",
            "explode": false,
            "example": [
              "renewable-energy",
              "green-finance"
            ]
          },
          {
            "name": "country",
            "in": "query",
            "required": false,
            "description": "Country as written on the jobs (A to Z letter case does not matter; accents must match). Send a comma list (a,b) or repeat the parameter. At most 5 values.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "maxItems": 5
            },
            "style": "form",
            "explode": false,
            "example": [
              "Germany"
            ]
          },
          {
            "name": "work_mode",
            "in": "query",
            "required": false,
            "description": "remote, hybrid or onsite. Comma list or repeated.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "remote",
                  "hybrid",
                  "onsite"
                ]
              },
              "maxItems": 3
            },
            "style": "form",
            "explode": false,
            "example": [
              "remote"
            ]
          },
          {
            "name": "employment_type",
            "in": "query",
            "required": false,
            "description": "For example full-time, part-time, contract, internship, freelance. Send a comma list (a,b) or repeat the parameter. At most 8 values.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "maxItems": 8
            },
            "style": "form",
            "explode": false,
            "example": [
              "full-time"
            ]
          },
          {
            "name": "seniority",
            "in": "query",
            "required": false,
            "description": "For example entry, mid, senior, lead, director, executive. Send a comma list (a,b) or repeat the parameter. At most 8 values.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "maxItems": 8
            },
            "style": "form",
            "explode": false,
            "example": [
              "senior"
            ]
          },
          {
            "name": "company",
            "in": "query",
            "required": false,
            "description": "A company slug (the `company.slug` of a job).",
            "schema": {
              "type": "string"
            },
            "example": "fjord-wind-partners"
          },
          {
            "name": "posted_since",
            "in": "query",
            "required": false,
            "description": "Only jobs posted on or after this: a date or time in ISO 8601 (2026-11-01 or 2026-11-01T08:00:00Z) or a number of days back such as 7d or 30d (1d to 3650d).",
            "schema": {
              "type": "string"
            },
            "example": "7d"
          },
          {
            "name": "salary_min",
            "in": "query",
            "required": false,
            "description": "Only jobs that state pay of at least this much per YEAR (hourly, weekly, daily and monthly pay is converted with the documented factors; jobs with an unknown pay period are left out). Needs `currency`.",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 100000000
            },
            "example": 50000
          },
          {
            "name": "currency",
            "in": "query",
            "required": false,
            "description": "ISO 4217 code. Required with salary_min; on its own it keeps only jobs that state pay in that currency.",
            "schema": {
              "type": "string",
              "pattern": "^[A-Za-z]{3}$"
            },
            "example": "EUR"
          },
          {
            "name": "has_salary",
            "in": "query",
            "required": false,
            "description": "true: only jobs that state pay. false: only jobs that do not.",
            "schema": {
              "type": "boolean"
            },
            "example": true
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Page size. Default 20, at most 50. Anything else is a 400.",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50
            },
            "example": 20
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The next_cursor of the previous page, with the same filters. Opaque and signed: a changed or foreign cursor is a 400.",
            "schema": {
              "type": "string",
              "maxLength": 400
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A page of jobs.",
            "headers": {
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/X-RateLimit-Reset"
              },
              "X-RateLimit-Daily-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Daily-Limit"
              },
              "X-RateLimit-Daily-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Daily-Remaining"
              },
              "X-API-Version": {
                "$ref": "#/components/headers/X-API-Version"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JobList"
                },
                "example": {
                  "data": [
                    {
                      "id": "f3b1c2d4e5a6",
                      "slug": "wind-farm-site-engineer-bergen-f3b1",
                      "title": "Wind Farm Site Engineer",
                      "company": {
                        "name": "Fjord Wind Partners",
                        "slug": "fjord-wind-partners",
                        "logo_url": "https://greenhired.com/files/logos/fjord.png"
                      },
                      "location": {
                        "city": "Bergen",
                        "state": "Vestland",
                        "country": "Norway",
                        "remote": false
                      },
                      "work_mode": "hybrid",
                      "employment_type": "full-time",
                      "seniority": "mid",
                      "green_category": "renewable-energy",
                      "salary": {
                        "min": 62000,
                        "max": 78000,
                        "currency": "EUR",
                        "period": "year"
                      },
                      "posted_at": "2026-11-12T08:00:00.000Z",
                      "expires_at": "2026-12-31T00:00:00.000Z",
                      "description_text": "Join our site team to commission offshore wind turbines...",
                      "url": "https://greenhired.com/jobs/wind-farm-site-engineer-bergen-f3b1/",
                      "source_type": "first_party"
                    }
                  ],
                  "page": {
                    "next_cursor": "eyJ2IjoxfQ.2Zc1w0b8mA",
                    "limit": 20,
                    "has_more": true
                  }
                }
              }
            }
          },
          "400": {
            "description": "A parameter or the cursor is not valid (invalid_parameter, unknown_parameter, invalid_cursor).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/Unavailable"
          }
        }
      }
    },
    "/jobs/{slug}": {
      "get": {
        "operationId": "getJob",
        "tags": [
          "Jobs"
        ],
        "summary": "Get one job",
        "description": "One job with its full description (plain text and sanitised HTML). Only jobs that GreenHired may hand on are returned: by default the jobs posted on GreenHired itself.",
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          }
        ],
        "x-required-scope": "jobs:read",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "description": "The job slug.",
            "schema": {
              "type": "string"
            },
            "example": "wind-farm-site-engineer-bergen-f3b1"
          }
        ],
        "responses": {
          "200": {
            "description": "The job.",
            "headers": {
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/X-RateLimit-Reset"
              },
              "X-RateLimit-Daily-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Daily-Limit"
              },
              "X-RateLimit-Daily-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Daily-Remaining"
              },
              "X-API-Version": {
                "$ref": "#/components/headers/X-API-Version"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JobResponse"
                },
                "example": {
                  "data": {
                    "id": "f3b1c2d4e5a6",
                    "slug": "wind-farm-site-engineer-bergen-f3b1",
                    "title": "Wind Farm Site Engineer",
                    "company": {
                      "name": "Fjord Wind Partners",
                      "slug": "fjord-wind-partners",
                      "logo_url": "https://greenhired.com/files/logos/fjord.png"
                    },
                    "location": {
                      "city": "Bergen",
                      "state": "Vestland",
                      "country": "Norway",
                      "remote": false
                    },
                    "work_mode": "hybrid",
                    "employment_type": "full-time",
                    "seniority": "mid",
                    "green_category": "renewable-energy",
                    "salary": {
                      "min": 62000,
                      "max": 78000,
                      "currency": "EUR",
                      "period": "year"
                    },
                    "posted_at": "2026-11-12T08:00:00.000Z",
                    "expires_at": "2026-12-31T00:00:00.000Z",
                    "description_text": "Join our site team to commission offshore wind turbines...",
                    "url": "https://greenhired.com/jobs/wind-farm-site-engineer-bergen-f3b1/",
                    "source_type": "first_party",
                    "description_html": "<p>Join our site team...</p>",
                    "skills": [
                      "commissioning",
                      "HV safety"
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "A query parameter was sent (this endpoint takes none).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "description": "No such job, or a job this API may not serve.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "410": {
            "description": "The job existed and has closed (expired, removed or archived).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/Unavailable"
          }
        }
      }
    },
    "/openapi.json": {
      "get": {
        "operationId": "getOpenApi",
        "tags": [
          "Account"
        ],
        "summary": "This document",
        "description": "The OpenAPI 3.1 description of the API. Public, no key needed, cacheable for an hour.",
        "security": [],
        "responses": {
          "200": {
            "description": "The OpenAPI document.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {}
                },
                "example": {}
              }
            }
          }
        }
      }
    },
    "/ping": {
      "get": {
        "operationId": "ping",
        "tags": [
          "Account"
        ],
        "summary": "Check your key",
        "description": "Says whose key it is, what it may do and how much it has used. Needs any valid key; counts as one request.",
        "security": [
          {
            "bearerAuth": []
          },
          {
            "apiKeyHeader": []
          }
        ],
        "responses": {
          "200": {
            "description": "The key is valid.",
            "headers": {
              "X-RateLimit-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Limit"
              },
              "X-RateLimit-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Remaining"
              },
              "X-RateLimit-Reset": {
                "$ref": "#/components/headers/X-RateLimit-Reset"
              },
              "X-RateLimit-Daily-Limit": {
                "$ref": "#/components/headers/X-RateLimit-Daily-Limit"
              },
              "X-RateLimit-Daily-Remaining": {
                "$ref": "#/components/headers/X-RateLimit-Daily-Remaining"
              },
              "X-API-Version": {
                "$ref": "#/components/headers/X-API-Version"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Ping"
                },
                "example": {
                  "ok": true,
                  "key": {
                    "name": "Partner key",
                    "scopes": [
                      "jobs:read"
                    ]
                  },
                  "limits": {
                    "requests_per_minute": 60,
                    "requests_per_day": 5000
                  },
                  "usage": {
                    "minute": {
                      "used": 0,
                      "remaining": 0,
                      "resets_in_seconds": 0
                    },
                    "today": {
                      "used": 0,
                      "remaining": 0
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "503": {
            "$ref": "#/components/responses/Unavailable"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Authorization: Bearer ghk_<32 characters>"
      },
      "apiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "The same key, in a header of its own."
      }
    },
    "headers": {
      "X-RateLimit-Limit": {
        "description": "Requests this key may make per minute.",
        "schema": {
          "type": "integer"
        }
      },
      "X-RateLimit-Remaining": {
        "description": "Requests left in the current minute.",
        "schema": {
          "type": "integer"
        }
      },
      "X-RateLimit-Reset": {
        "description": "Seconds until the minute window ends.",
        "schema": {
          "type": "integer"
        }
      },
      "X-RateLimit-Daily-Limit": {
        "description": "Requests this key may make per UTC day.",
        "schema": {
          "type": "integer"
        }
      },
      "X-RateLimit-Daily-Remaining": {
        "description": "Requests left today (UTC).",
        "schema": {
          "type": "integer"
        }
      },
      "X-API-Version": {
        "description": "Always 1.",
        "schema": {
          "type": "string"
        }
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "No key (missing_key), a key that is not valid (invalid_key) or a revoked key (revoked_key).",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "Over the per-minute limit (rate_limited) or the daily cap (daily_cap_reached). Retry-After says how many seconds to wait.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unavailable": {
        "description": "The API is switched off (api_disabled), or could not check your key (api_unavailable).",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "The key does not have the scope this endpoint needs (insufficient_scope).",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "schemas": {
      "Category": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "example": "renewable-energy"
          },
          "name": {
            "type": "string",
            "example": "Renewable Energy"
          },
          "sector": {
            "type": "string",
            "example": "Energy"
          },
          "description": {
            "type": "string",
            "example": "Solar, wind, hydro and geothermal roles."
          },
          "open_jobs": {
            "type": "integer",
            "description": "Live jobs in this category that this API may show.",
            "example": 120,
            "minimum": 0
          }
        },
        "additionalProperties": false,
        "required": [
          "slug",
          "name",
          "sector",
          "description",
          "open_jobs"
        ]
      },
      "CategoryList": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Category"
            },
            "maxItems": 28
          }
        },
        "additionalProperties": false,
        "required": [
          "data"
        ]
      },
      "Error": {
        "type": "object",
        "description": "Every error answer has this shape.",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "A short stable code to program against.",
                "example": "invalid_parameter",
                "enum": [
                  "missing_key",
                  "invalid_key",
                  "revoked_key",
                  "insufficient_scope",
                  "rate_limited",
                  "daily_cap_reached",
                  "api_disabled",
                  "api_unavailable",
                  "invalid_parameter",
                  "unknown_parameter",
                  "invalid_cursor",
                  "not_found",
                  "gone",
                  "method_not_allowed",
                  "server_error"
                ]
              },
              "message": {
                "type": "string",
                "description": "A sentence for a person. The wording can change; the code does not.",
                "example": "limit must be a whole number from 1 to 50."
              }
            },
            "additionalProperties": false,
            "required": [
              "code",
              "message"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "error"
        ]
      },
      "Job": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "An opaque, stable job id.",
            "example": "f3b1c2d4e5a6"
          },
          "slug": {
            "type": "string",
            "description": "The job slug: /v1/jobs/{slug} and https://greenhired.com/jobs/{slug}/.",
            "example": "wind-farm-site-engineer-bergen-f3b1"
          },
          "title": {
            "type": "string",
            "example": "Wind Farm Site Engineer"
          },
          "company": {
            "$ref": "#/components/schemas/JobCompany"
          },
          "location": {
            "$ref": "#/components/schemas/JobLocation"
          },
          "work_mode": {
            "type": [
              "string",
              "null"
            ],
            "example": "hybrid",
            "enum": [
              "remote",
              "hybrid",
              "onsite",
              null
            ]
          },
          "employment_type": {
            "type": [
              "string",
              "null"
            ],
            "description": "Usually full-time, part-time, contract, internship or freelance.",
            "example": "full-time"
          },
          "seniority": {
            "type": [
              "string",
              "null"
            ],
            "description": "Usually entry, mid, senior, lead, director or executive.",
            "example": "mid"
          },
          "green_category": {
            "type": "string",
            "description": "Slug of one of the 28 green categories (see /v1/categories).",
            "example": "renewable-energy"
          },
          "salary": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/Salary"
              },
              {
                "type": "null"
              }
            ]
          },
          "posted_at": {
            "type": "string",
            "description": "When the job was posted (or, for a job without a posting date, first seen). UTC.",
            "example": "2026-11-12T08:00:00.000Z",
            "format": "date-time"
          },
          "expires_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "The closing date, UTC. null when the job has none.",
            "example": "2026-12-31T00:00:00.000Z",
            "format": "date-time"
          },
          "description_text": {
            "type": "string",
            "description": "Plain text. On a list: the first 600 characters. On /v1/jobs/{slug}: all of it, up to 60000 characters.",
            "example": "Join our site team to commission offshore wind turbines..."
          },
          "url": {
            "type": "string",
            "description": "The job on GreenHired. Always link back to it when you show this job (see \"Attribution\" in the docs).",
            "example": "https://greenhired.com/jobs/wind-farm-site-engineer-bergen-f3b1/",
            "format": "uri"
          },
          "source_type": {
            "type": "string",
            "description": "\"first_party\" for a job posted on GreenHired; otherwise the name of the feed it came from (only when the owner has cleared that source for the API).",
            "example": "first_party"
          }
        },
        "additionalProperties": false,
        "required": [
          "id",
          "slug",
          "title",
          "company",
          "location",
          "work_mode",
          "employment_type",
          "seniority",
          "green_category",
          "salary",
          "posted_at",
          "expires_at",
          "description_text",
          "url",
          "source_type"
        ]
      },
      "JobCompany": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Company name.",
            "example": "Fjord Wind Partners"
          },
          "slug": {
            "type": [
              "string",
              "null"
            ],
            "description": "Company slug on GreenHired; null for a company that has no page on GreenHired.",
            "example": "fjord-wind-partners"
          },
          "logo_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "Absolute address of the logo, or null.",
            "example": "https://greenhired.com/files/logos/fjord.png",
            "format": "uri"
          }
        },
        "additionalProperties": false,
        "required": [
          "name",
          "slug",
          "logo_url"
        ]
      },
      "JobDetail": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "An opaque, stable job id.",
            "example": "f3b1c2d4e5a6"
          },
          "slug": {
            "type": "string",
            "description": "The job slug: /v1/jobs/{slug} and https://greenhired.com/jobs/{slug}/.",
            "example": "wind-farm-site-engineer-bergen-f3b1"
          },
          "title": {
            "type": "string",
            "example": "Wind Farm Site Engineer"
          },
          "company": {
            "$ref": "#/components/schemas/JobCompany"
          },
          "location": {
            "$ref": "#/components/schemas/JobLocation"
          },
          "work_mode": {
            "type": [
              "string",
              "null"
            ],
            "example": "hybrid",
            "enum": [
              "remote",
              "hybrid",
              "onsite",
              null
            ]
          },
          "employment_type": {
            "type": [
              "string",
              "null"
            ],
            "description": "Usually full-time, part-time, contract, internship or freelance.",
            "example": "full-time"
          },
          "seniority": {
            "type": [
              "string",
              "null"
            ],
            "description": "Usually entry, mid, senior, lead, director or executive.",
            "example": "mid"
          },
          "green_category": {
            "type": "string",
            "description": "Slug of one of the 28 green categories (see /v1/categories).",
            "example": "renewable-energy"
          },
          "salary": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/Salary"
              },
              {
                "type": "null"
              }
            ]
          },
          "posted_at": {
            "type": "string",
            "description": "When the job was posted (or, for a job without a posting date, first seen). UTC.",
            "example": "2026-11-12T08:00:00.000Z",
            "format": "date-time"
          },
          "expires_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "The closing date, UTC. null when the job has none.",
            "example": "2026-12-31T00:00:00.000Z",
            "format": "date-time"
          },
          "description_text": {
            "type": "string",
            "description": "Plain text. On a list: the first 600 characters. On /v1/jobs/{slug}: all of it, up to 60000 characters.",
            "example": "Join our site team to commission offshore wind turbines..."
          },
          "url": {
            "type": "string",
            "description": "The job on GreenHired. Always link back to it when you show this job (see \"Attribution\" in the docs).",
            "example": "https://greenhired.com/jobs/wind-farm-site-engineer-bergen-f3b1/",
            "format": "uri"
          },
          "source_type": {
            "type": "string",
            "description": "\"first_party\" for a job posted on GreenHired; otherwise the name of the feed it came from (only when the owner has cleared that source for the API).",
            "example": "first_party"
          },
          "description_html": {
            "type": "string",
            "description": "The full description (cut at 60,000 characters) as sanitised HTML: paragraphs, line breaks, lists, headings, bold and italic, links, images, tables, div and span; never a script, style, event handler or form. Links and images are absolute addresses. Safe to insert into a page.",
            "example": "<p>Join our site team...</p>"
          },
          "skills": {
            "type": "array",
            "description": "Skill tags, possibly empty.",
            "example": [
              "commissioning",
              "HV safety"
            ],
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "id",
          "slug",
          "title",
          "company",
          "location",
          "work_mode",
          "employment_type",
          "seniority",
          "green_category",
          "salary",
          "posted_at",
          "expires_at",
          "description_text",
          "url",
          "source_type",
          "description_html",
          "skills"
        ]
      },
      "JobList": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Job"
            },
            "maxItems": 50
          },
          "page": {
            "$ref": "#/components/schemas/Page"
          }
        },
        "additionalProperties": false,
        "required": [
          "data",
          "page"
        ]
      },
      "JobLocation": {
        "type": "object",
        "properties": {
          "city": {
            "type": [
              "string",
              "null"
            ],
            "example": "Bergen"
          },
          "state": {
            "type": [
              "string",
              "null"
            ],
            "example": "Vestland"
          },
          "country": {
            "type": [
              "string",
              "null"
            ],
            "example": "Norway"
          },
          "remote": {
            "type": "boolean",
            "description": "True when work_mode is remote.",
            "example": false
          }
        },
        "additionalProperties": false,
        "required": [
          "city",
          "state",
          "country",
          "remote"
        ]
      },
      "JobResponse": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/JobDetail"
          }
        },
        "additionalProperties": false,
        "required": [
          "data"
        ]
      },
      "Page": {
        "type": "object",
        "properties": {
          "next_cursor": {
            "type": [
              "string",
              "null"
            ],
            "description": "Send this as `cursor` to get the next page. null on the last page. Opaque: do not parse it.",
            "example": "eyJ2IjoxfQ.2Zc1w0b8mA"
          },
          "limit": {
            "type": "integer",
            "description": "The page size used.",
            "example": 20,
            "minimum": 1,
            "maximum": 50
          },
          "has_more": {
            "type": "boolean",
            "description": "True when another page follows.",
            "example": true
          }
        },
        "additionalProperties": false,
        "required": [
          "next_cursor",
          "limit",
          "has_more"
        ]
      },
      "Ping": {
        "type": "object",
        "description": "Whose key it is, what it may do and how much it has used.",
        "properties": {
          "ok": {
            "type": "boolean",
            "example": true
          },
          "key": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "Partner key"
              },
              "scopes": {
                "type": "array",
                "example": [
                  "jobs:read"
                ],
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false,
            "required": [
              "name",
              "scopes"
            ]
          },
          "limits": {
            "type": "object",
            "properties": {
              "requests_per_minute": {
                "type": "integer",
                "example": 60
              },
              "requests_per_day": {
                "type": "integer",
                "example": 5000
              }
            },
            "additionalProperties": false,
            "required": [
              "requests_per_minute",
              "requests_per_day"
            ]
          },
          "usage": {
            "type": "object",
            "properties": {
              "minute": {
                "type": "object",
                "properties": {
                  "used": {
                    "type": "integer"
                  },
                  "remaining": {
                    "type": "integer"
                  },
                  "resets_in_seconds": {
                    "type": "integer"
                  }
                },
                "additionalProperties": false,
                "required": [
                  "used",
                  "remaining",
                  "resets_in_seconds"
                ]
              },
              "today": {
                "type": "object",
                "properties": {
                  "used": {
                    "type": "integer"
                  },
                  "remaining": {
                    "type": "integer"
                  }
                },
                "additionalProperties": false,
                "required": [
                  "used",
                  "remaining"
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "minute",
              "today"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "ok",
          "key",
          "limits",
          "usage"
        ]
      },
      "Salary": {
        "type": "object",
        "description": "The pay as stated on the job, not converted.",
        "properties": {
          "min": {
            "type": [
              "integer",
              "null"
            ],
            "example": 62000
          },
          "max": {
            "type": [
              "integer",
              "null"
            ],
            "example": 78000
          },
          "currency": {
            "type": [
              "string",
              "null"
            ],
            "description": "ISO 4217 code as stated by the employer.",
            "example": "EUR"
          },
          "period": {
            "type": [
              "string",
              "null"
            ],
            "description": "What min and max are per. null when the employer did not say.",
            "example": "year",
            "enum": [
              "year",
              "month",
              "week",
              "day",
              "hour",
              null
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "min",
          "max",
          "currency",
          "period"
        ]
      },
      "SalaryInsight": {
        "type": "object",
        "description": "Yearly pay of the jobs in one group, using the middle of each job's stated range.",
        "properties": {
          "category": {
            "type": [
              "string",
              "null"
            ],
            "description": "The category slug, or null when the answer is not grouped by category.",
            "example": "renewable-energy"
          },
          "country": {
            "type": [
              "string",
              "null"
            ],
            "description": "The country as written on the jobs, or null when not grouped by country.",
            "example": "Germany"
          },
          "currency": {
            "type": "string",
            "description": "ISO 4217 code. Currencies are never mixed or converted.",
            "example": "EUR"
          },
          "period": {
            "type": "string",
            "description": "Always year: every figure is a yearly amount.",
            "const": "year"
          },
          "sample_size": {
            "type": "integer",
            "description": "Number of jobs behind the figures (at least 5).",
            "example": 42,
            "minimum": 5
          },
          "min": {
            "type": "integer",
            "example": 38000
          },
          "p25": {
            "type": "integer",
            "example": 52000
          },
          "median": {
            "type": "integer",
            "example": 61000
          },
          "p75": {
            "type": "integer",
            "example": 72000
          },
          "max": {
            "type": "integer",
            "example": 110000
          }
        },
        "additionalProperties": false,
        "required": [
          "category",
          "country",
          "currency",
          "period",
          "sample_size",
          "min",
          "p25",
          "median",
          "p75",
          "max"
        ]
      },
      "SalaryInsightList": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SalaryInsight"
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "period": {
                "type": "string",
                "const": "year"
              },
              "min_sample_size": {
                "type": "integer",
                "description": "A group with fewer jobs is left out.",
                "example": 5
              },
              "group_by": {
                "type": "array",
                "example": [
                  "category"
                ],
                "items": {
                  "type": "string",
                  "enum": [
                    "category",
                    "country"
                  ]
                }
              },
              "truncated": {
                "type": "boolean",
                "description": "True when there were more salary jobs than one answer reads (the figures then use the most recent ones).",
                "example": false
              }
            },
            "additionalProperties": false,
            "required": [
              "period",
              "min_sample_size",
              "group_by",
              "truncated"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "data",
          "meta"
        ]
      }
    }
  }
}
