HHS (US Department of Health and Human Services) User v1 - Internal Only API
The User v1 - Internal Only API from HHS (US Department of Health and Human Services) — 23 operation(s) for user v1 - internal only.
HHS (US Department of Health and Human Services) User v1 - Internal Only 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 User v1 - Internal Only. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 6 JSON Schemas.
This API exposes 26 operations across 23 paths, and defines 103 schemas. It is described by OpenAPI 3.1.0, at version v0.
Requests are made against the base URL https://api.fda.gov.
26 operations
23 paths
103 schemas
4 DELETE4 GET15 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
HHS (US Department of Health and Human Services) User v1 - Internal Only 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 26
Across 23 paths, the API surfaces 26 operations — 4 DELETE, 4 GET, 15 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
User v1 - Internal Only 26
GET
/v1/users/login
User Login
POST
/v1/users/token/logout
User Token Logout
POST
/v1/users/token/refresh
User Token Refresh
GET
/v1/users/{user_id}
User Get
PUT
/v1/users/{user_id}/profile
Update the authenticated user's profile data'
POST
/v1/users/{user_id}/agencies
User Get Agencies
POST
/v1/users/{user_id}/api-keys
Create a new API key for the authenticated user
POST
/v1/users/{user_id}/privileges
Get the roles and privileges for the authenticated user
POST
/v1/users/{user_id}/can_access
Check user access for a given resource
POST
/v1/users/{user_id}/applications
Get all applications for a user
GET
/v1/users/{user_id}/organizations
User Get Organizations
POST
/v1/users/{user_id}/api-keys/list
List all API keys for the authenticated user
POST
/v1/users/{user_id}/saved-searches
User Save Search
POST
/v1/users/{user_id}/invitations/list
Get all invitations for a user by matching their login.gov email
POST
/v1/users/{user_id}/saved-opportunities
User Save Opportunity
POST
/v1/users/{user_id}/saved-searches/list
User Get Saved Searches
POST
/v1/users/{user_id}/saved-opportunities/list
User Get Saved Opportunities
PUT
/v1/users/{user_id}/api-keys/{api_key_id}
Rename an existing API key for the authenticated user
DELETE
/v1/users/{user_id}/api-keys/{api_key_id}
Delete (deactivate) an API key for the authenticated user
GET
/v1/users/{user_id}/saved-opportunities/notifications
User Get Saved Opportunity Notifications
POST
/v1/users/{user_id}/saved-opportunities/notifications
User Saved Opportunities Notifications
PUT
/v1/users/{user_id}/saved-searches/{saved_search_id}
User Update Saved Search
DELETE
/v1/users/{user_id}/saved-searches/{saved_search_id}
User Delete Saved Search
DELETE
/v1/users/{user_id}/saved-opportunities/{opportunity_id}
User Delete Saved Opportunity
POST
/v1/users/{user_id}/invitations/{invitation_id}/organizations
User Response Org Invitation
DELETE
/v1/users/{user_id}/saved-opportunities/{legacy_opportunity_id}
User Delete Saved Opportunity Legacy
Schemas 103
The contract defines 103 schemas that model the data the API accepts and returns. The most detailed are OpportunitySearchFilterV1Schema (14 properties), UserInvitationItemSchema (7 properties), OpportunitySearchRequestV1Schema (6 properties), SamGovEntityResponseSchema (6 properties). Each schema is shown below with its type and property counts.
UserApiKeyCreateResponseSchema
object
3 properties
UserInvitationOrganizationSchema
object
2 properties
UserApiKeyListRequestSchema
object
RoleSchema
object
3 properties
UserDeleteSavedSearchResponseSchema
object
3 properties
UserApiKeyCreateRequestSchema
object
1 property
1 required
UserSaveSearchRequestSchema
object
2 properties
1 required
ValidationIssueSchema
object
4 properties
UserAgencySchema
object
3 properties
UserDeleteSavedOpportunityResponseSchema
object
3 properties
UserApplicationApplicationStatusFiilterSchema
object
1 property
UserTokenRefreshResponseSchema
object
3 properties
EstimatedTotalProgramFundingFilterV1Schema
object
2 properties
UserProfile
object
3 properties
UserApplicationListResponseSchema
object
3 properties
UserApiKeyDeleteResponseSchema
object
3 properties
UserSchema
object
4 properties
UserSavedOpportunitiesResponseSchema
object
3 properties
UserUpdateProfileRequestSchema
object
3 properties
UserOrganization
object
2 properties
ErrorResponseSchema
object
5 properties
UserGetResponseSchema
object
3 properties
UserResponseOrgInvitationResponseSchema
object
3 properties
UserCanAccessRequestSchema
object
3 properties
UserApplicationOpportunitySchema
object
3 properties
UserAgency
object
2 properties
UserUpdateProfileResponseSchema
object
3 properties
UserUpdateSavedSearchRequestSchema
object
1 property
1 required
UserInvitationRoleSchema
object
3 properties
UserSaveOpportunityRequestSchema
object
1 property
1 required
UserInvitationInviterUserSchema
object
4 properties
UserApplicationListRequestSchema
object
2 properties
1 required
ApplicantTypeFilterV1Schema
object
1 property
SamGovEntityResponseSchema
object
6 properties
UserOrganizationsResponseSchema
object
3 properties
GetRolesAndPrivilegesResponseSchema
object
5 properties
SavedOpportunityNotificationsOrgSchema
object
2 properties
UserApplicationApplicationCompetitionIDFilterSchema
object
1 property
UserInvitationListRequestSchema
object
SortOrderUserGetSavedSearchPaginationV1Schema
object
2 properties
2 required
UserInvitationItemSchema
object
7 properties
SavedSearchResponseSchema
object
4 properties
AssistanceListingNumberFilterV1Schema
object
1 property
GetUserRolesAndPrivilegesApplicationSchema
object
2 properties
UserApplicationListItemSchema
object
5 properties
SavedOpportunityOrganizationSchema
object
2 properties
OpportunitySearchFilterV1Schema
object
14 properties
SortOrderUserApplicationPaginationSchema
object
2 properties
2 required
GetUserRolesAndPrivilegesOrganizationSchema
object
1 property
UserApplication
object
2 properties
SetUserSavedOpportunityNotificationRequestSchema
object
2 properties
2 required
UserTokenLogoutResponseSchema
object
3 properties
UserCanAccessResponseSchema
object
3 properties
UserResponseOrgInvitationRequestSchema
object
1 property
SavedOpportunityStatusFieldFilterSchema
object
1 property
SavedOpportunitySummaryV1Schema
object
3 properties
SavedOpportunityNotificationsSelfSchema
object
1 property
UserApplicationPaginationSchema
object
3 properties
2 required
UserApiKeyRenameRequestSchema
object
1 property
1 required
UserApplicationApplicationOrganizationIDFilterSchema
object
1 property
SortOrderOpportunityPaginationV1Schema
object
2 properties
2 required
SortOrderUserGetSavedOpportunityPaginationV1Schema
object
2 properties
2 required
UserSavedOpportunityNotificationsResponseSchema
object
3 properties
OrganizationInvitationSchema
object
5 properties
UserApiKeyListResponseSchema
object
3 properties
InvitationRoleSchema
object
2 properties
OpportunityStatusFilterV1Schema
object
1 property
AwardFloorFilterV1Schema
object
2 properties
UserGetSavedSearchPaginationV1Schema
object
3 properties
2 required
UserUpdateSavedSearchResponseSchema
object
3 properties
TopLevelAgencyOppSearchFilterV1Schema
object
1 property
FundingCategoryFilterV1Schema
object
1 property
AwardCeilingFilterV1Schema
object
2 properties
UserSaveSearchResponseSchema
object
3 properties
UserSavedSearchesResponseSchema
object
3 properties
FundingInstrumentFilterV1Schema
object
1 property
UserOrganizationSchema
object
2 properties
UserApplicationCompetitionSchema
object
6 properties
UserGetSavedOpportunityPaginationV1Schema
object
3 properties
2 required
IsCostSharingFilterV1Schema
object
1 property
UserSavedOpportunitiesFilterSchema
object
2 properties
UserSavedOpportunitiesOrganizationIDSFilterSchema
object
1 property
OpportunitySearchRequestV1Schema
object
6 properties
1 required
ExperimentalV1Schema
object
1 property
OpportunityPaginationV1Schema
object
3 properties
2 required
UserSavedSearchesRequestSchema
object
1 property
1 required
UserApiKeyRenameResponseSchema
object
3 properties
UserSavedOpportunitiesRequestSchema
object
2 properties
1 required
UserSaveOpportunityResponseSchema
object
3 properties
ExpectedNumberAwardsFilterV1Schema
object
2 properties
CloseDateFilterV1Schema
object
4 properties
UserApplicationFilterSchema
object
3 properties
PostDateFilterV1Schema
object
4 properties
SavedOpportunityNotificationsSchema
object
2 properties
SavedOpportunityResponseV1Schema
object
5 properties
SetUserSavedOpportunityNotificationResponseSchema
object
3 properties
UserAgenciesResponseSchema
object
3 properties
UserApiKeySchema
object
6 properties
OrganizationSchema1
object
2 properties
UserGetRolesAndPrivilegesResponseSchema
object
3 properties
UserInvitationListResponseSchema
object
3 properties
GetUserRolesAndPrivilegesAgencySchema
object
1 property
AgencyOppSearchFilterV1Schema
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HHS (US Department of Health and Human Services) 12
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
#User v1 - Internal Only