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) Agency v1 API

The Agency v1 API from HHS (US Department of Health and Human Services) — 1 operation(s) for agency v1.

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

This API exposes 1 operation across 1 path, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version v0.

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

1 operations 1 paths 13 schemas 1 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) Agency v1 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Agency v1 1
POST
/v1/agencies/search
Agency Search
body → 200422401

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are AgencyV1Schema (8 properties), PaginationInfoSchema (5 properties), ErrorResponseSchema (5 properties), ValidationIssueSchema (4 properties). Each schema is shown below with its type and property counts.

HasActiveOpportunityFilterV1Schema
object
1 property
AgencySearchFilterV1Schema
object
3 properties
AgencySearchResponseV1Schema
object
4 properties
AgencyV1Schema
object
8 properties
AgencySearchRequestSchema
object
4 properties 1 required
PaginationInfoSchema
object
5 properties
OpportunityStatusesFilterV1Schema
object
1 property
AgencySearchPaginationV1Schema
object
3 properties 2 required
IsTestAgencyFilterV1Schema
object
1 property
ErrorResponseSchema
object
5 properties
SortOrderSchema
object
2 properties
SortOrderAgencySearchPaginationV1Schema
object
2 properties 2 required
ValidationIssueSchema
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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