How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HHS (US Department of Health and Human Services) Opportunity v1 - for Grantors API

The Opportunity v1 - for Grantors API from HHS (US Department of Health and Human Services) — 8 operation(s) for opportunity v1 - for grantors.

HHS (US Department of Health and Human Services) Opportunity v1 - for Grantors 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 Opportunity v1 - for Grantors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 6 JSON Schemas.

This API exposes 9 operations across 8 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version v0.

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

9 operations 8 paths 34 schemas 1 DELETE1 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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) Opportunity v1 - for Grantors 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 9

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

Opportunity v1 - for Grantors 9
POST
/v1/grantors/opportunities
Create a new opportunity
postV1GrantorsOpportunities body → 200422401403404500
GET
/v1/grantors/opportunities/{opportunity_id}
Get an editable opportunity for grantors
getV1GrantorsOpportunitiesByOpportunityId 1 param → 200401404403500
PUT
/v1/grantors/opportunities/{opportunity_id}
Update an existing opportunity
putV1GrantorsOpportunitiesByOpportunityId 1 param body → 200422401404403
POST
/v1/grantors/agencies/{agency_id}/opportunities
Get paginated list of opportunities by agency
postV1GrantorsAgenciesByAgencyIdOpportunities 1 param body → 200422401404403500
POST
/v1/grantors/opportunities/{opportunity_id}/publish
Publish an opportunity
postV1GrantorsOpportunitiesByOpportunityIdPublish 1 param → 200401404403422500
POST
/v1/grantors/opportunities/{opportunity_id}/summaries
Create a new opportunity summary
postV1GrantorsOpportunitiesByOpportunityIdSummaries 1 param body → 200422401404403500
POST
/v1/grantors/opportunities/{opportunity_id}/attachments
Upload an attachment to an opportunity
postV1GrantorsOpportunitiesByOpportunityIdAttachments 1 param body → 200422401404403500
PUT
/v1/grantors/opportunities/{opportunity_id}/summaries/{opportunity_summary_id}
Update an existing opportunity summary
putV1GrantorsOpportunitiesByOpportunityIdSummariesByOpportunitySummaryId 2 params body → 200422401404403500
DELETE
/v1/grantors/opportunities/{opportunity_id}/attachments/{opportunity_attachment_id}
Delete an attachment from an opportunity
deleteV1GrantorsOpportunitiesByOpportunityIdAttachmentsByOpportunityAttachmentId 2 params → 200401404403422500

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are OpportunitySummaryDetailSchema (31 properties), OpportunitySummaryV1Schema (30 properties), OpportunitySummaryCreateRequestV1Schema (27 properties), OpportunitySummaryUpdateRequestV1Schema (26 properties). Each schema is shown below with its type and property counts.

SortOrderSchema
object
2 properties
OpportunityUploadAttachmentResponseV1Schema
object
4 properties 2 required
OpportunitySummaryCreateRequestV1Schema
object
27 properties 12 required
SortOrderOpportunityListPaginationSchema
object
2 properties 2 required
OpportunityGetResponseSchema
object
3 properties
CompetitionInstructionAlphaSchema
object
4 properties
OpportunityAssistanceListingV1Schema
object
2 properties
FormAlphaSchema
object
17 properties
OpportunitySummaryCreateResponseV1Schema
object
3 properties
OpportunityPublishResponseV1Schema
object
3 properties
OpportunityListResponseSchema
object
4 properties
CompetitionAlphaSchema
object
12 properties
FormInstructionSchema
object
5 properties
DeleteAttachmentResponseV1Schema
object
3 properties 2 required
PaginationInfoSchema
object
5 properties
OpportunityListRequestSchema
object
2 properties 1 required
CompetitionFormAlphaSchema
object
2 properties
AwardRecommendationReadySchema
object
1 property
OpportunitySummaryUpdateRequestV1Schema
object
26 properties 11 required
OpportunitySummaryUpdateResponseV1Schema
object
3 properties
OpportunityAttachmentResponseV1Schema
object
2 properties 1 required
OpportunityUploadAttachmentRequestV1Schema
object
2 properties 1 required
OpportunityCreateRequestSchema
object
6 properties 5 required
ValidationIssueSchema
object
4 properties
OpportunityCreateResponseSchema
object
3 properties
OpportunitySummaryV1Schema
object
30 properties
OpportunityAttachmentV1Schema
object
8 properties
OpportunityGrantorSchema
object
21 properties
OpportunitySummaryDetailSchema
object
31 properties 1 required
ErrorResponseSchema
object
5 properties
OpportunityListFilterSchema
object
1 property
OpportunityUpdateRequestSchema
object
3 properties 2 required
OpportunityUpdateResponseSchema
object
3 properties
OpportunityListPaginationSchema
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hhs-opportunity-v1-for-grantors-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) CommonGrants Protocol 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
Where this information came from

This is an independent, third-party profile of HHS (US Department of Health and Human Services) Opportunity v1 - for Grantors API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.