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

The Organization v1 API from HHS (US Department of Health and Human Services) — 10 operation(s) for organization v1.

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

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

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

11 operations 10 paths 41 schemas 2 DELETE1 GET7 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) Organization 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 11

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

Organization v1 11
GET
/v1/organizations/{organization_id}
Get organization information by ID
1 param → 200401404403
POST
/v1/organizations/{organization_id}/users
Get paginated list of users in an organization
1 param body → 200422401404403
POST
/v1/organizations/{organization_id}/roles/list
List organization roles
1 param → 200401404403
POST
/v1/organizations/{organization_id}/invitations
Create an invitation for a new organization member
1 param body → 200422401404400403
POST
/v1/organizations/{organization_id}/legacy-users
List legacy users that can be invited to the organization.
1 param body → 200422401404400403
POST
/v1/organizations/{organization_id}/invitations/list
List organization invitations with filtering
1 param body → 200422401404400403
POST
/v1/organizations/{organization_id}/legacy-users/ignore
Organization Ignore Legacy User
1 param body → 200422401404400403
POST
/v1/organizations/{organization_id}/saved-opportunities
Save an opportunity for an organization
1 param body → 200422401404403
PUT
/v1/organizations/{organization_id}/users/{user_id}
Update roles for an organization user
2 params body → 200422401404403
DELETE
/v1/organizations/{organization_id}/users/{user_id}
Remove a user from an organization
2 params → 200401404403
DELETE
/v1/organizations/{organization_id}/saved-opportunities/{opportunity_id}
Delete a saved opportunity for an organization
2 params → 200401404403

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are OrganizationInvitationDataSchema (10 properties), OrganizationInvitationResponseSchema (7 properties), OrganizationUserSchema (6 properties), SamGovEntityResponseSchema (6 properties). Each schema is shown below with its type and property counts.

OrganizationInvitationListRequestSchema
object
2 properties
OrganizationUserSchema
object
6 properties
OrganizationSaveOpportunityResponseSchema
object
3 properties
OrganizationInvitationDataSchema
object
10 properties
OrganizationUsersResponseSchema
object
4 properties
InviterDataSchema
object
4 properties
InviteeDataSchema
object
4 properties
InvitationStatusFilterSchema
object
1 property
OrganizationUsersPaginationSchema
object
3 properties 2 required
ValidationIssueSchema
object
4 properties
OrganizationCreateInvitationResponseSchema
object
3 properties
RoleSchema1
object
3 properties
OrganizationGetResponseSchema
object
3 properties
OrganizationCreateInvitationRequestSchema
object
2 properties 2 required
OrganizationUsersListRequestSchema
object
1 property 1 required
OrganizationInvitationListPaginationSchema
object
3 properties
OrganizationIgnoreLegacyUserResponseSchema
object
3 properties
PaginationInfoSchema
object
5 properties
OrganizationUpdateUserRolesRequestSchema
object
1 property
OrganizationRemoveUserResponseSchema
object
3 properties
SortOrderOrganizationInvitationListPaginationSchema
object
2 properties 2 required
OrganizationIgnoreLegacyUserRequestSchema
object
1 property 1 required
LegacyUsersListResponseSchema
object
4 properties
OrganizationDataSchema
object
2 properties
OrganizationInvitationFilterSchema
object
1 property
LegacyUserStatusFilterSchema
object
1 property
LegacyUserDataSchema
object
4 properties 2 required
SamGovEntityResponseSchema
object
6 properties
LegacyUserPaginationSchema
object
3 properties 2 required
OrganizationUpdateUserRolesResponseSchema
object
3 properties
OrganizationInvitationListResponseSchema
object
4 properties
OrganizationInvitationResponseSchema
object
7 properties
LegacyUserFilterSchema
object
1 property
OrganizationDeleteSavedOpportunityResponseSchema
object
3 properties
OrganizationListRolesResponseSchema
object
3 properties
SortOrderLegacyUserPaginationSchema
object
2 properties 2 required
SortOrderOrganizationUsersPaginationSchema
object
2 properties 2 required
LegacyUsersListRequestSchema
object
2 properties 1 required
ErrorResponseSchema
object
5 properties
SortOrderSchema
object
2 properties
OrganizationSaveOpportunityRequestSchema
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hhs-organization-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) 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