Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HHS (US Department of Health and Human Services) CommonGrants Protocol API

CommonGrants-compliant API routes for searching opportunities to promote interoperability across grant systems. Learn more by visiting CommonGrants.org

HHS (US Department of Health and Human Services) CommonGrants Protocol API is one of 21 APIs that HHS (US Department of Health and Human Services) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include CommonGrants Protocol. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 6 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 40 schemas. It is described by OpenAPI 3.1.0, at version v0.

Requests are made against the base URL https://api.fda.gov.

3 operations 3 paths 40 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v0
Base URL
https://api.fda.gov
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

HHS (US Department of Health and Human Services) CommonGrants Protocol API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-SGG-Token (ApiJwtAuth). An API key is passed in the header as X-SGG-Internal-Token (InternalApiJwtAuth). An API key is passed in the header as X-API-Key (ApiUserKeyAuth).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

CommonGrants Protocol 3

CommonGrants-compliant API routes for searching opportunities to promote interoperability across grant systems. Learn more by visiting CommonGrants.org

GET
/common-grants/opportunities
List opportunities
2 params → 200422401
POST
/common-grants/opportunities/search
Search opportunities
body → 200422401
GET
/common-grants/opportunities/{oppId}
View opportunity details
1 param → 200401404

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are OpportunityCustomFields (10 properties), OpportunityBase (10 properties), AttachmentValue (7 properties), OppFunding (7 properties). Each schema is shown below with its type and property counts.

AdditionalInfoValue
object
2 properties
PaginatedResultsInfo
object
4 properties 2 required
OpportunitiesSearchResponse
object
6 properties 6 required
AgencyContactValue
object
4 properties
attachments
object
5 properties 2 required
PaginatedBodyParams
object
2 properties
fiscalYear
object
5 properties 3 required
costSharing
object
5 properties 3 required
Money
object
2 properties 2 required
MoneyRange
object
2 properties
ValidationIssueSchema
object
4 properties
additionalInfo
object
5 properties 3 required
DateRangeFilter
object
2 properties 2 required
CostSharingValue
object
1 property
StringArrayFilter
object
2 properties 2 required
OpportunityCustomFields
object
10 properties
OppTimeline
object
3 properties
AgencyValue
object
4 properties
MoneyRangeFilter
object
2 properties 2 required
OpportunitySearchRequest
object
4 properties
OpportunityBase
object
10 properties
assistanceListings
object
5 properties 2 required
OppFilters
object
6 properties
OppStatus
object
3 properties
FilterInfo
object
2 properties 1 required
OpportunitiesListResponse
object
4 properties 4 required
agency
object
5 properties 3 required
contactInfo
object
5 properties 3 required
AttachmentValue
object
7 properties 3 required
legacySerialId
object
5 properties 3 required
federalOpportunityNumber
object
5 properties 3 required
AssistanceListingValue
object
2 properties
SortedResultsInfo
object
4 properties 2 required
OppSorting
object
3 properties 1 required
OppFunding
object
7 properties
OpportunityResponse
object
3 properties 3 required
ErrorResponseSchema
object
5 properties
DateRange
object
2 properties
federalFundingSource
object
5 properties 3 required
SingleDateEvent
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hhs-commongrants-protocol-api-openapi.yml Raw ↑

Other APIs HHS (US Department of Health and Human Services) publishes across the network.

openFDA API
MyHealthfinder API
ONC Health IT Open Data API
HRSA Health Center Data Web Service
HealthData.gov Catalog API
HHS (US Department of Health and Human Services) Agency v1 API
HHS (US Department of Health and Human Services) Application Alpha API
HHS (US Department of Health and Human Services) Award Recommendation Alpha API
HHS (US Department of Health and Human Services) Competition Alpha API
HHS (US Department of Health and Human Services) Extract v1 API
HHS (US Department of Health and Human Services) File v1 API
HHS (US Department of Health and Human Services) Form Alpha API