HHS (US Department of Health and Human Services) · Example Payload

V1_Opportunities_Search_Post_Request

HealthPublic HealthGrantsInteroperabilityFHIRGovernmentOpen DataFDAHRSAONC

V1_Opportunities_Search_Post_Request is an example object payload from HHS (US Department of Health and Human Services), with 7 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

example1example2example3example4example5example6example7

Example Payload

{
  "example1": {
    "summary": "No filters",
    "value": {
      "pagination": {
        "sort_order": [
          {
            "order_by": "opportunity_id",
            "sort_direction": "ascending"
          }
        ],
        "page_offset": 1,
        "page_size": 25
      }
    }
  },
  "example2": {
    "summary": "All filters",
    "value": {
      "query": "research",
      "filters": {
        "agency": {
          "one_of": [
            "USAID",
            "DOC"
          ]
        },
        "applicant_type": {
          "one_of": [
            "state_governments",
            "county_governments",
            "individuals"
          ]
        },
        "funding_category": {
          "one_of": [
            "recovery_act",
            "arts",
            "natural_resources"
          ]
        },
        "funding_instrument": {
          "one_of": [
            "cooperative_agreement",
            "grant"
          ]
        },
        "opportunity_status": {
          "one_of": [
            "forecasted",
            "posted"
          ]
        },
        "post_date": {
          "start_date": "2024-01-01",
          "end_date": "2024-02-01"
        },
        "close_date": {
          "start_date": "2024-01-01"
        }
      },
      "pagination": {
        "sort_order": [
          {
            "order_by": "opportunity_id",
            "sort_direction": "ascending"
          }
        ],
        "page_offset": 1,
        "page_size": 25
      }
    }
  },
  "example3": {
    "summary": "Query & opportunity_status filters",
    "value": {
      "query": "research",
      "filters": {
        "opportunity_status": {
          "one_of": [
            "forecasted",
            "posted"
          ]
        }
      },
      "pagination": {
        "sort_order": [
          {
            "order_by": "opportunity_id",
            "sort_direction": "ascending"
          }
        ],
        "page_offset": 1,
        "page_size": 25
      }
    }
  },
  "example4": {
    "summary": "CSV file response",
    "value": {
      "format": "csv",
      "filters": {
        "opportunity_status": {
          "one_of": [
            "forecasted",
            "posted"
          ]
        }
      },
      "pagination": {
        "sort_order": [
          {
            "order_by": "opportunity_id",
            "sort_direction": "ascending"
          }
        ],
        "page_offset": 1,
        "page_size": 100
      }
    }
  },
  "example5": {
    "summary": "Filter by award fields",
    "value": {
      "filters": {
        "expected_number_of_awards": {
          "min": 5
        },
        "award_floor": {
          "min": 10000
        },
        "award_ceiling": {
          "max": 1000000
        },
        "estimated_total_program_funding": {
          "min": 100000,
          "max": 250000
        }
      },
      "pagination": {
        "sort_order": [
          {
            "order_by": "opportunity_id",
            "sort_direction": "ascending"
          }
        ],
        "page_offset": 1,
        "page_size": 25
      }
    }
  },
  "example6": {
    "summary": "Filter by assistance listing numbers",
    "value": {
      "filters": {
        "assistance_listing_number": {
          "one_of": [
            "43.001",
            "47.049"
          ]
        }
      },
      "pagination": {
        "sort_order": [
          {
            "order_by": "opportunity_id",
            "sort_direction": "ascending"
          }
        ],
        "page_offset": 1,
        "page_size": 25
      }
    }
  },
  "example7": {
    "summary": "Primary sort agency_code desc, secondary sort opportunity_id asc",
    "value": {
      "pagination": {
        "page_offset": 1,
        "page_size": 25,
        "sort_order": [
          {
            "order_by": "agency_code",
            "sort_direction": "descending"
          },
          {
            "order_by": "opportunity_id",
            "sort_direction": "ascending"
          }
        ]
      }
    }
  }
}