How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.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.2.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
getV1OrganizationsByOrganizationId 1 param → 200401404403
POST
/v1/organizations/{organization_id}/users
Get paginated list of users in an organization
postV1OrganizationsByOrganizationIdUsers 1 param body → 200422401404403
POST
/v1/organizations/{organization_id}/roles/list
List organization roles
postV1OrganizationsByOrganizationIdRolesList 1 param → 200401404403
POST
/v1/organizations/{organization_id}/invitations
Create an invitation for a new organization member
postV1OrganizationsByOrganizationIdInvitations 1 param body → 200422401404400403
POST
/v1/organizations/{organization_id}/legacy-users
List legacy users that can be invited to the organization
postV1OrganizationsByOrganizationIdLegacyUsers 1 param body → 200422401404400403
POST
/v1/organizations/{organization_id}/invitations/list
List organization invitations with filtering
postV1OrganizationsByOrganizationIdInvitationsList 1 param body → 200422401404400403
POST
/v1/organizations/{organization_id}/legacy-users/ignore
Organization Ignore Legacy User
postV1OrganizationsByOrganizationIdLegacyUsersIgnore 1 param body → 200422401404400403
POST
/v1/organizations/{organization_id}/saved-opportunities
Save an opportunity for an organization
postV1OrganizationsByOrganizationIdSavedOpportunities 1 param body → 200422401404403
PUT
/v1/organizations/{organization_id}/users/{user_id}
Update roles for an organization user
putV1OrganizationsByOrganizationIdUsersByUserId 2 params body → 200422401404403
DELETE
/v1/organizations/{organization_id}/users/{user_id}
Remove a user from an organization
deleteV1OrganizationsByOrganizationIdUsersByUserId 2 params → 200401404403
DELETE
/v1/organizations/{organization_id}/saved-opportunities/{opportunity_id}
Delete a saved opportunity for an organization
deleteV1OrganizationsByOrganizationIdSavedOpportunitiesByOpportunityId 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.

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

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
Where this information came from

This is an independent, third-party profile of HHS (US Department of Health and Human Services) Organization v1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.