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) Application Alpha API

The Application Alpha API from HHS (US Department of Health and Human Services) — 11 operation(s) for application alpha.

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

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

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

14 operations 11 paths 53 schemas 1 DELETE3 GET5 POST5 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) Application 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 14

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

Application Alpha 14
POST
/alpha/applications/start
Create a new application for a competition
body → 200422401404
GET
/alpha/applications/{application_id}
Get an application by ID
1 param → 200401404
PUT
/alpha/applications/{application_id}
Update an application
1 param body → 200422401404403
POST
/alpha/applications/{application_id}/submit
Submit an application
1 param → 200401404
POST
/alpha/applications/{application_id}/attachments
Create an attachment on an application
1 param body → 200422401404
POST
/alpha/applications/{application_id}/submissions
Get all application submissions for an application
1 param body → 200422401404403
POST
/alpha/applications/{application_id}/audit_history
Application Audit List
1 param body → 200422401404
PUT
/alpha/applications/{application_id}/forms/{form_id}
Update an application form response
2 params body → 200422401404
PUT
/alpha/applications/{application_id}/forms/{form_id}/inclusion
Update whether an application form should be included in submission
2 params body → 200422401404
GET
/alpha/applications/{application_id}/application_form/{app_form_id}
Get an application form by ID
2 params → 200401404
PUT
/alpha/applications/{application_id}/organizations/{organization_id}
Add an organization to an application
2 params → 200401404403422
GET
/alpha/applications/{application_id}/attachments/{application_attachment_id}
Fetch an application attachment
2 params → 200401404422
PUT
/alpha/applications/{application_id}/attachments/{application_attachment_id}
Update an attachment on an application
2 params body → 200422401404
DELETE
/alpha/applications/{application_id}/attachments/{application_attachment_id}
Delete an application attachment
2 params → 200401404

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are FormAlphaSchema (17 properties), ApplicationFormGetResponseDataSchema (13 properties), CompetitionAlphaSchema (12 properties), ApplicationGetResponseDataSchema (10 properties). Each schema is shown below with its type and property counts.

SimpleUserSchema
object
4 properties
ApplicationAuditRequestPaginationSchema
object
3 properties 2 required
FormAlphaSchema
object
17 properties
ApplicationSubmissionsRequestSchema
object
1 property 1 required
ApplicationAttachmentGetResponseSchema
object
3 properties
ApplicationAuditAppFormSchema
object
4 properties
CompetitionFormAlphaSchema
object
2 properties
ApplicationFormGetResponseSchema
object
4 properties
FormInstructionSchema
object
5 properties
ApplicationAuditFilterSchema
object
1 property
ApplicationAttachmentCreateResponseSchema
object
3 properties
ApplicationAttachmentUpdateRequestSchema
object
1 property 1 required
ValidationIssueSchema
object
4 properties
AbstractResponseSchema
object
3 properties
PaginationInfoSchema
object
5 properties
ApplicationUpdateResponseSchema
object
4 properties
ApplicationSubmissionsResponseSchema
object
4 properties
ApplicationUserSchema
object
2 properties
ApplicationFormGetResponseDataSchema
object
13 properties
ApplicationAuditDataSchema
object
7 properties
ApplicationAttachmentCreateSchema
object
1 property
ApplicationUpdateResponseDataSchema
object
1 property
ApplicationStartRequestSchema
object
4 properties 1 required
ApplicationAddOrganizationResponseSchema
object
3 properties
SamGovEntityResponseSchema
object
6 properties
ApplicationUpdateRequestSchema
object
1 property 1 required
OrganizationSchema
object
2 properties
ApplicationFormUpdateResponseSchema
object
4 properties
ApplicationStartResponseDataSchema
object
1 property
ApplicationFormInclusionUpdateResponseSchema
object
3 properties
ApplicationSubmissionsRequestPaginationSchema
object
3 properties 2 required
ApplicationGetResponseSchema
object
4 properties
ApplicationAttachmentDeleteResponseSchema
object
3 properties
ApplicationSubmissionDataSchema
object
4 properties
SortOrderApplicationSubmissionsRequestPaginationSchema
object
2 properties 2 required
ApplicationFormUpdateRequestSchema
object
2 properties 1 required
ApplicationAttachmentNoLinkSchema
object
6 properties
ApplicationAuditResponseSchema
object
4 properties
ApplicationAttachmentGetSchema
object
7 properties
ApplicationStartResponseSchema
object
3 properties
ApplicationAuditRequestSchema
object
2 properties 1 required
SortOrderApplicationAuditRequestPaginationSchema
object
2 properties 2 required
ApplicationAttachmentCreateRequestSchema
object
1 property 1 required
ApplicationAttachmentUpdateResponseSchema
object
3 properties
ApplicationAuditEventFieldFilterSchema
object
1 property
ErrorResponseSchema
object
5 properties
CompetitionAlphaSchema
object
12 properties
CompetitionInstructionAlphaSchema
object
4 properties
SortOrderSchema
object
2 properties
OpportunityAssistanceListingV1Schema
object
2 properties
ApplicationFormInclusionUpdateRequestSchema
object
1 property 1 required
ApplicationAuditAttachmentSchema
object
3 properties
ApplicationGetResponseDataSchema
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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