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) Workflow API

The Workflow API from HHS (US Department of Health and Human Services) — 4 operation(s) for workflow.

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

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

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

4 operations 4 paths 20 schemas 2 GET1 POST1 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) Workflow 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 4

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

Workflow 4
PUT
/v1/workflows/events
Send Workflow Event
body → 200422401403404
GET
/v1/workflows/{workflow_id}
Get Workflow Details
1 param → 200401404403
GET
/v1/workflows/events/{event_id}
Get Workflow by Event ID
1 param → 200401404403
POST
/v1/workflows/{workflow_id}/audit
Get Workflow Audit Events
1 param body → 200422401404403

Schemas 20

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

WorkflowEventResponseSchema
object
3 properties
ValidationIssueSchema
object
4 properties
PaginationInfoSchema
object
5 properties
WorkflowApprovalSchema
object
8 properties
WorkflowUserSchema
object
4 properties
ProcessWorkflowContextSchema
object
2 properties 2 required
WorkflowEventResponseDataSchema
object
1 property
StartWorkflowContextSchema
object
3 properties 3 required
WorkflowEventRequestSchema
object
4 properties 1 required
WorkflowGetResponseDataSchema
object
13 properties
WorkflowEventHistorySchema
object
2 properties
WorkflowAuditRequestSchema
object
1 property 1 required
WorkflowAuditPaginationSchema
object
3 properties
WorkflowApprovalConfigItemSchema
object
4 properties
WorkflowGetResponseSchema
object
3 properties
SortOrderWorkflowAuditPaginationSchema
object
2 properties 2 required
ErrorResponseSchema
object
5 properties
WorkflowAuditResponseSchema
object
4 properties
WorkflowAuditEventSchema
object
8 properties
SortOrderSchema
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hhs-workflow-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