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) 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.1.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.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) 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
body → 200422401403404500
GET
/v1/grantors/opportunities/{opportunity_id}
Get an editable opportunity for grantors
1 param → 200401404403500
PUT
/v1/grantors/opportunities/{opportunity_id}
Update an existing opportunity
1 param body → 200422401404403
POST
/v1/grantors/agencies/{agency_id}/opportunities
Get paginated list of opportunities by agency
1 param body → 200422401404403500
POST
/v1/grantors/opportunities/{opportunity_id}/publish
Publish an opportunity
1 param → 200401404403422500
POST
/v1/grantors/opportunities/{opportunity_id}/summaries
Create a new opportunity summary
1 param body → 200422401404403500
POST
/v1/grantors/opportunities/{opportunity_id}/attachments
Upload an attachment to an opportunity
1 param body → 200422401404403500
PUT
/v1/grantors/opportunities/{opportunity_id}/summaries/{opportunity_summary_id}
Update an existing opportunity summary
2 params body → 200422401404403500
DELETE
/v1/grantors/opportunities/{opportunity_id}/attachments/{opportunity_attachment_id}
Delete an attachment from an opportunity
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.

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