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) Award Recommendation Alpha API

The Award Recommendation Alpha API from HHS (US Department of Health and Human Services) — 11 operation(s) for award recommendation alpha.

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

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

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

13 operations 11 paths 59 schemas 2 DELETE1 GET6 POST4 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) Award Recommendation Alpha 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 13

Across 11 paths, the API surfaces 13 operations — 2 DELETE, 1 GET, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Award Recommendation Alpha 13
POST
/alpha/award-recommendations
Create Award Recommendation
body → 200422401403404
POST
/alpha/award-recommendations/list
List Award Recommendations
body → 200422401403404
GET
/alpha/award-recommendations/{award_recommendation_id}
Get Award Recommendation
1 param → 200401404403
PUT
/alpha/award-recommendations/{award_recommendation_id}
Update Award Recommendation
1 param body → 200422401404403
POST
/alpha/award-recommendations/{award_recommendation_id}/risks
Create Award Recommendation Risk
1 param body → 200422401404403
POST
/alpha/award-recommendations/{award_recommendation_id}/risks/list
List Award Recommendation Risks
1 param body → 200422401404403
POST
/alpha/award-recommendations/{award_recommendation_id}/audit_history
List Award Recommendation Audit History
1 param body → 200422401404403
POST
/alpha/award-recommendations/{award_recommendation_id}/submissions/list
List Award Recommendation Submissions
1 param body → 200422401404403
PUT
/alpha/award-recommendations/{award_recommendation_id}/submission-details
Batch Update Award Recommendation Submission Details
1 param body → 200422401404403500
PUT
/alpha/award-recommendations/{award_recommendation_id}/risks/{award_recommendation_risk_id}
Update Award Recommendation Risk
2 params body → 200422401404403
DELETE
/alpha/award-recommendations/{award_recommendation_id}/risks/{award_recommendation_risk_id}
Delete Award Recommendation Risk
2 params → 200401404403
PUT
/alpha/award-recommendations/{award_recommendation_id}/reviews/{award_recommendation_review_id}
Update Award Recommendation Review
2 params body → 200422401404403
DELETE
/alpha/award-recommendations/{award_recommendation_id}/attachments/{award_recommendation_attachment_id}
Delete Award Recommendation Attachment
2 params → 200401404403

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are AwardRecommendationWithAttachmentsSchema (12 properties), AwardRecommendationBaseSchema (11 properties), AwardRecommendationAuditDataSchema (10 properties), AwardRecommendationAttachmentSchema (7 properties). Each schema is shown below with its type and property counts.

SimpleUserSchema
object
4 properties
AwardRecSubmissionTypeFilterSchema
object
1 property
AwardRecSubmissionPaginationSchema
object
3 properties 2 required
SortOrderAwardRecommendationListPaginationSchema
object
2 properties 2 required
AwardRecommendationRiskListResponseSchema
object
4 properties
AwardRecommendationReviewSchema
object
3 properties
AwardRecommendationRiskDeleteResponseSchema
object
3 properties
AwardRecommendationAttachmentDeleteResponseSchema
object
3 properties
AwardRecommendationSubmissionDetailSchema
object
6 properties
AwardRecommendationBaseSchema
object
11 properties
AwardRecommendationSubmissionDetailUpdateSchema
object
6 properties
AwardRecommendationApplicationSchema
object
3 properties
ValidationIssueSchema
object
4 properties
AwardRecommendationAuditAttachmentSchema
object
4 properties
AwardRecRiskPaginationSchema
object
3 properties 2 required
AwardRecommendationSubmissionDataSchema
object
3 properties
AwardRecSubmissionExceptionFilterSchema
object
1 property
AwardRecommendationReviewUpdateResponseSchema
object
3 properties
AwardRecommendationUpdateRequestSchema
object
5 properties 1 required
AwardRecommendationOrganizationSchema
object
2 properties
AwardRecommendationOpportunitySchema
object
4 properties
PaginationInfoSchema
object
5 properties
AwardRecommendationSubmissionListRequestSchema
object
2 properties 1 required
AwardRecommendationAuditReviewSchema
object
2 properties
AwardRecommendationListAgencyIdFilterSchema
object
1 property
AwardRecommendationAuditRequestSchema
object
2 properties 1 required
AwardRecommendationAuditFilterSchema
object
1 property
AwardRecommendationListRequestSchema
object
2 properties 2 required
AwardRecommendationGetResponseSchema
object
3 properties
AwardRecommendationAuditWorkflowApprovalSchema
object
4 properties
AwardRecommendationAuditRiskSchema
object
4 properties
SortOrderAwardRecAuditPaginationSchema
object
2 properties 2 required
AwardRecommendationSubmissionDetailsBatchUpdateRequestSchema
object
1 property 1 required
AwardRecommendationOpportunitySummarySchema
object
2 properties
AwardRecommendationSubmissionFilterSchema
object
2 properties
AwardRecommendationListPaginationSchema
object
3 properties 2 required
AwardRecommendationListFilterSchema
object
1 property 1 required
AwardRecommendationSubmissionListResponseSchema
object
4 properties
AwardRecommendationWithAttachmentsSchema
object
12 properties
SortOrderAwardRecRiskPaginationSchema
object
2 properties 2 required
AwardRecommendationRiskResponseDataSchema
object
6 properties
AwardRecommendationCreateRequestSchema
object
6 properties 2 required
AwardRecAuditEventFilterSchema
object
1 property
AwardRecommendationAttachmentSchema
object
7 properties
AwardRecAuditPaginationSchema
object
3 properties 2 required
AwardRecommendationSubmissionDetailsBatchUpdateResponseSchema
object
3 properties
ApplicationSubmissionInfoSchema
object
3 properties
AwardRecommendationRiskRequestSchema
object
3 properties 3 required
AwardRecommendationRiskResponseSchema
object
3 properties
AwardRecommendationAuditResponseSchema
object
4 properties
AwardRecommendationApplicationSubmissionSchema
object
5 properties
AwardRecommendationListResponseSchema
object
4 properties
AwardRecommendationAuditDataSchema
object
10 properties
AwardRecommendationRiskListRequestSchema
object
1 property 1 required
ErrorResponseSchema
object
5 properties
SortOrderAwardRecSubmissionPaginationSchema
object
2 properties 2 required
SortOrderSchema
object
2 properties
AwardRecommendationAuditAppSubmissionSchema
object
3 properties
AwardRecommendationReviewUpdateRequestSchema
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hhs-award-recommendation-alpha-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) 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
HHS (US Department of Health and Human Services) Form Alpha API