{
  "service": "highergov",
  "displayName": "HigherGov",
  "categories": [
    "Data"
  ],
  "authTypes": [
    "api_key"
  ],
  "auth": [
    {
      "type": "api_key",
      "label": "API Key",
      "placeholder": "HIGHERGOV_API_KEY",
      "description": "HigherGov API key sent as the api_key query parameter. Create or manage it from the API page in your HigherGov account: https://www.highergov.com/api-management/."
    }
  ],
  "homepageUrl": "https://www.highergov.com/",
  "actions": [
    {
      "id": "highergov.list_agencies",
      "service": "highergov",
      "name": "list_agencies",
      "description": "List HigherGov federal, state, and local agencies and their hierarchies.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "agency_key": {
            "type": "integer",
            "description": "The HigherGov agency key to filter by."
          },
          "page_number": {
            "type": "integer",
            "minimum": 1,
            "description": "The result page number, starting from 1."
          },
          "page_size": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "description": "The number of records to return, from 1 through 100."
          }
        },
        "additionalProperties": false,
        "description": "The filters and pagination options for listing HigherGov agencies."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "A HigherGov result record whose fields depend on the requested API family."
            },
            "description": "The records returned for the requested page."
          },
          "meta": {
            "type": "object",
            "properties": {
              "pagination": {
                "type": "object",
                "properties": {
                  "page": {
                    "type": "integer",
                    "description": "The current page number."
                  },
                  "pages": {
                    "type": "integer",
                    "description": "The total number of result pages."
                  },
                  "count": {
                    "type": "integer",
                    "description": "The total number of matching records."
                  }
                },
                "additionalProperties": false,
                "required": [
                  "page",
                  "pages",
                  "count"
                ],
                "description": "The current pagination state."
              }
            },
            "additionalProperties": false,
            "required": [
              "pagination"
            ],
            "description": "Pagination metadata returned by HigherGov."
          },
          "links": {
            "type": "object",
            "properties": {
              "first": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The first-page URL, or null when unavailable.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "last": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The last-page URL, or null when unavailable.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "next": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The next-page URL, or null when there is no next page.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "prev": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The previous-page URL, or null when there is no previous page.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "first",
              "last",
              "next",
              "prev"
            ],
            "description": "Credential-free pagination links returned by HigherGov."
          }
        },
        "additionalProperties": false,
        "required": [
          "results",
          "meta",
          "links"
        ],
        "description": "A paginated response returned by HigherGov."
      }
    },
    {
      "id": "highergov.list_contracts",
      "service": "highergov",
      "name": "list_contracts",
      "description": "List HigherGov federal prime contract awards using documented award filters.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "award_id": {
            "type": "string",
            "description": "The government award ID to filter by."
          },
          "awardee_key": {
            "type": "integer",
            "description": "The HigherGov awardee key to filter by."
          },
          "awardee_key_parent": {
            "type": "integer",
            "description": "The parent-level HigherGov awardee key to filter by."
          },
          "awardee_uei": {
            "type": "string",
            "description": "The awardee Unique Entity Identifier to filter by."
          },
          "awardee_uei_parent": {
            "type": "string",
            "description": "The parent awardee Unique Entity Identifier to filter by."
          },
          "awarding_agency_key": {
            "type": "integer",
            "description": "The HigherGov awarding agency key to filter by."
          },
          "captured_date": {
            "type": "string",
            "description": "Return contracts captured on or after this date.",
            "format": "date"
          },
          "funding_agency_key": {
            "type": "integer",
            "description": "The HigherGov funding agency key to filter by."
          },
          "last_modified_date": {
            "type": "string",
            "description": "Return contracts modified on or after this date.",
            "format": "date"
          },
          "naics_code": {
            "type": "string",
            "description": "The award NAICS code to filter by."
          },
          "ordering": {
            "type": "string",
            "enum": [
              "-action_date",
              "-current_total_value_of_award",
              "-last_modified_date",
              "-period_of_performance_potential_end_date",
              "-period_of_performance_start_date",
              "-potential_total_value_of_award",
              "-total_dollars_obligated",
              "action_date",
              "current_total_value_of_award",
              "last_modified_date",
              "period_of_performance_potential_end_date",
              "period_of_performance_start_date",
              "potential_total_value_of_award",
              "total_dollars_obligated"
            ],
            "description": "The field and direction used to order results."
          },
          "page_number": {
            "type": "integer",
            "minimum": 1,
            "description": "The result page number, starting from 1."
          },
          "page_size": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "description": "The number of records to return, from 1 through 100."
          },
          "parent_award_id": {
            "type": "string",
            "description": "The government award ID of the parent award."
          },
          "psc_code": {
            "type": "string",
            "description": "The Product Service Code to filter by."
          },
          "search_id": {
            "type": "string",
            "description": "The HigherGov saved search ID to apply."
          },
          "vehicle_key": {
            "type": "integer",
            "description": "The HigherGov contract vehicle key to filter by."
          }
        },
        "additionalProperties": false,
        "description": "The filters and pagination options for listing HigherGov federal contracts."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "A HigherGov result record whose fields depend on the requested API family."
            },
            "description": "The records returned for the requested page."
          },
          "meta": {
            "type": "object",
            "properties": {
              "pagination": {
                "type": "object",
                "properties": {
                  "page": {
                    "type": "integer",
                    "description": "The current page number."
                  },
                  "pages": {
                    "type": "integer",
                    "description": "The total number of result pages."
                  },
                  "count": {
                    "type": "integer",
                    "description": "The total number of matching records."
                  }
                },
                "additionalProperties": false,
                "required": [
                  "page",
                  "pages",
                  "count"
                ],
                "description": "The current pagination state."
              }
            },
            "additionalProperties": false,
            "required": [
              "pagination"
            ],
            "description": "Pagination metadata returned by HigherGov."
          },
          "links": {
            "type": "object",
            "properties": {
              "first": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The first-page URL, or null when unavailable.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "last": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The last-page URL, or null when unavailable.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "next": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The next-page URL, or null when there is no next page.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "prev": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The previous-page URL, or null when there is no previous page.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "first",
              "last",
              "next",
              "prev"
            ],
            "description": "Credential-free pagination links returned by HigherGov."
          }
        },
        "additionalProperties": false,
        "required": [
          "results",
          "meta",
          "links"
        ],
        "description": "A paginated response returned by HigherGov."
      }
    },
    {
      "id": "highergov.list_naics_codes",
      "service": "highergov",
      "name": "list_naics_codes",
      "description": "List HigherGov NAICS industry classification codes and descriptions.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "naics_code": {
            "type": "string",
            "description": "The full or partial NAICS code to filter by."
          },
          "ordering": {
            "type": "string",
            "enum": [
              "-naics_code",
              "naics_code"
            ],
            "description": "The direction used to order results by NAICS code."
          },
          "page_number": {
            "type": "integer",
            "minimum": 1,
            "description": "The result page number, starting from 1."
          },
          "page_size": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "description": "The number of records to return, from 1 through 100."
          }
        },
        "additionalProperties": false,
        "description": "The filters and pagination options for listing HigherGov NAICS codes."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "A HigherGov result record whose fields depend on the requested API family."
            },
            "description": "The records returned for the requested page."
          },
          "meta": {
            "type": "object",
            "properties": {
              "pagination": {
                "type": "object",
                "properties": {
                  "page": {
                    "type": "integer",
                    "description": "The current page number."
                  },
                  "pages": {
                    "type": "integer",
                    "description": "The total number of result pages."
                  },
                  "count": {
                    "type": "integer",
                    "description": "The total number of matching records."
                  }
                },
                "additionalProperties": false,
                "required": [
                  "page",
                  "pages",
                  "count"
                ],
                "description": "The current pagination state."
              }
            },
            "additionalProperties": false,
            "required": [
              "pagination"
            ],
            "description": "Pagination metadata returned by HigherGov."
          },
          "links": {
            "type": "object",
            "properties": {
              "first": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The first-page URL, or null when unavailable.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "last": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The last-page URL, or null when unavailable.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "next": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The next-page URL, or null when there is no next page.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "prev": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The previous-page URL, or null when there is no previous page.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "first",
              "last",
              "next",
              "prev"
            ],
            "description": "Credential-free pagination links returned by HigherGov."
          }
        },
        "additionalProperties": false,
        "required": [
          "results",
          "meta",
          "links"
        ],
        "description": "A paginated response returned by HigherGov."
      }
    },
    {
      "id": "highergov.list_opportunities",
      "service": "highergov",
      "name": "list_opportunities",
      "description": "List HigherGov federal contract, DIBBS, grant, and state or local opportunities using documented filters.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "agency_key": {
            "type": "integer",
            "description": "The HigherGov agency key to filter by."
          },
          "captured_date": {
            "type": "string",
            "description": "Return opportunities captured on or after this date.",
            "format": "date"
          },
          "opp_key": {
            "type": "string",
            "description": "The HigherGov opportunity key to retrieve."
          },
          "ordering": {
            "type": "string",
            "enum": [
              "-captured_date",
              "-due_date",
              "-posted_date",
              "captured_date",
              "due_date",
              "posted_date"
            ],
            "description": "The field and direction used to order results."
          },
          "page_number": {
            "type": "integer",
            "minimum": 1,
            "description": "The result page number, starting from 1."
          },
          "page_size": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "description": "The number of records to return, from 1 through 100."
          },
          "posted_date": {
            "type": "string",
            "description": "Return opportunities posted on or after this date.",
            "format": "date"
          },
          "search_id": {
            "type": "string",
            "description": "The HigherGov saved search ID to apply."
          },
          "source_id": {
            "type": "string",
            "description": "The source opportunity ID to filter by."
          },
          "source_type": {
            "type": "string",
            "description": "One source type or a comma-separated list of source types such as sam,sled."
          },
          "version_key": {
            "type": "string",
            "description": "The HigherGov opportunity version key to retrieve."
          }
        },
        "additionalProperties": false,
        "description": "The filters and pagination options for listing HigherGov opportunities."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "A HigherGov result record whose fields depend on the requested API family."
            },
            "description": "The records returned for the requested page."
          },
          "meta": {
            "type": "object",
            "properties": {
              "pagination": {
                "type": "object",
                "properties": {
                  "page": {
                    "type": "integer",
                    "description": "The current page number."
                  },
                  "pages": {
                    "type": "integer",
                    "description": "The total number of result pages."
                  },
                  "count": {
                    "type": "integer",
                    "description": "The total number of matching records."
                  }
                },
                "additionalProperties": false,
                "required": [
                  "page",
                  "pages",
                  "count"
                ],
                "description": "The current pagination state."
              }
            },
            "additionalProperties": false,
            "required": [
              "pagination"
            ],
            "description": "Pagination metadata returned by HigherGov."
          },
          "links": {
            "type": "object",
            "properties": {
              "first": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The first-page URL, or null when unavailable.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "last": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The last-page URL, or null when unavailable.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "next": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The next-page URL, or null when there is no next page.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "prev": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The previous-page URL, or null when there is no previous page.",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "first",
              "last",
              "next",
              "prev"
            ],
            "description": "Credential-free pagination links returned by HigherGov."
          }
        },
        "additionalProperties": false,
        "required": [
          "results",
          "meta",
          "links"
        ],
        "description": "A paginated response returned by HigherGov."
      }
    }
  ]
}