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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
HHS (US Department of Health and Human Services)

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.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.

Specification
OpenAPI 3.2.0
API Version
v0
Base URL
https://api.fda.gov
Authentication
API Key, API Key, API Key
Contact
Simpler Grants.gov
Resource Areas
1

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
getV1UsersLogin 1 param → 422302
POST
/v1/users/token/logout
User Token Logout
postV1UsersTokenLogout → 200401
POST
/v1/users/token/refresh
User Token Refresh
postV1UsersTokenRefresh → 200401
GET
/v1/users/{user_id}
User Get
getV1UsersByUserId 1 param → 200401404
PUT
/v1/users/{user_id}/profile
Update the authenticated user's profile data'
putV1UsersByUserIdProfile 1 param body → 200422401404403
POST
/v1/users/{user_id}/agencies
User Get Agencies
postV1UsersByUserIdAgencies 1 param → 200401404403
POST
/v1/users/{user_id}/api-keys
Create a new API key for the authenticated user
postV1UsersByUserIdApiKeys 1 param body → 200422401404400403
POST
/v1/users/{user_id}/privileges
Get the roles and privileges for the authenticated user
postV1UsersByUserIdPrivileges 1 param → 200401404403
POST
/v1/users/{user_id}/can_access
Check user access for a given resource
postV1UsersByUserIdCanAccess 1 param body → 200422401404403
POST
/v1/users/{user_id}/applications
Get all applications for a user
postV1UsersByUserIdApplications 1 param body → 200422401404403
GET
/v1/users/{user_id}/organizations
User Get Organizations
getV1UsersByUserIdOrganizations 1 param → 200401404403
POST
/v1/users/{user_id}/api-keys/list
List all API keys for the authenticated user
postV1UsersByUserIdApiKeysList 1 param body → 200422401404403
POST
/v1/users/{user_id}/saved-searches
User Save Search
postV1UsersByUserIdSavedSearches 1 param body → 200422401404403
POST
/v1/users/{user_id}/invitations/list
Get all invitations for a user by matching their login.gov email
postV1UsersByUserIdInvitationsList 1 param body → 200422401404403
POST
/v1/users/{user_id}/saved-opportunities
User Save Opportunity
postV1UsersByUserIdSavedOpportunities 1 param body → 200422401404403
POST
/v1/users/{user_id}/saved-searches/list
User Get Saved Searches
postV1UsersByUserIdSavedSearchesList 1 param body → 200422401404403
POST
/v1/users/{user_id}/saved-opportunities/list
User Get Saved Opportunities
postV1UsersByUserIdSavedOpportunitiesList 1 param body → 200422401404403
PUT
/v1/users/{user_id}/api-keys/{api_key_id}
Rename an existing API key for the authenticated user
putV1UsersByUserIdApiKeysByApiKeyId 2 params body → 200422401404400403
DELETE
/v1/users/{user_id}/api-keys/{api_key_id}
Delete (deactivate) an API key for the authenticated user
deleteV1UsersByUserIdApiKeysByApiKeyId 2 params → 200401404403
GET
/v1/users/{user_id}/saved-opportunities/notifications
User Get Saved Opportunity Notifications
getV1UsersByUserIdSavedOpportunitiesNotifications 1 param → 200401404403
POST
/v1/users/{user_id}/saved-opportunities/notifications
User Saved Opportunities Notifications
postV1UsersByUserIdSavedOpportunitiesNotifications 1 param body → 200422401404403
PUT
/v1/users/{user_id}/saved-searches/{saved_search_id}
User Update Saved Search
putV1UsersByUserIdSavedSearchesBySavedSearchId 2 params body → 200422401404403
DELETE
/v1/users/{user_id}/saved-searches/{saved_search_id}
User Delete Saved Search
deleteV1UsersByUserIdSavedSearchesBySavedSearchId 2 params → 200401404403
DELETE
/v1/users/{user_id}/saved-opportunities/{opportunity_id}
User Delete Saved Opportunity
deleteV1UsersByUserIdSavedOpportunitiesByOpportunityId 2 params → 200401404403
POST
/v1/users/{user_id}/invitations/{invitation_id}/organizations
User Response Org Invitation
postV1UsersByUserIdInvitationsByInvitationIdOrganizations 2 params body → 200422401404403
DELETE
/v1/users/{user_id}/saved-opportunities/{legacy_opportunity_id}
User Delete Saved Opportunity Legacy
deleteV1UsersByUserIdSavedOpportunitiesByLegacyOpportunityId 2 params → 200401404

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), UserApplicationCompetitionSchema (6 properties). Each schema is shown below with its type and property counts.

FundingCategoryFilterV1Schema
object
1 property
OpportunityPaginationV1Schema
object
3 properties 2 required
SortOrderOpportunityPaginationV1Schema
object
2 properties 2 required
GetRolesAndPrivilegesResponseSchema
object
5 properties
UserSavedOpportunityNotificationsResponseSchema
object
3 properties
UserGetSavedSearchPaginationV1Schema
object
3 properties 2 required
OrganizationSchema1
object
2 properties
SavedOpportunityNotificationsSelfSchema
object
1 property
UserUpdateSavedSearchRequestSchema
object
1 property 1 required
UserApplication
object
2 properties
UserApiKeyListResponseSchema
object
3 properties
GetUserRolesAndPrivilegesAgencySchema
object
1 property
SavedOpportunityOrganizationSchema
object
2 properties
SavedOpportunitySummaryV1Schema
object
3 properties
RoleSchema
object
3 properties
CloseDateFilterV1Schema
object
4 properties
UserUpdateProfileResponseSchema
object
3 properties
UserApiKeyListRequestSchema
object
AssistanceListingNumberFilterV1Schema
object
1 property
UserCanAccessRequestSchema
object
3 properties
UserGetRolesAndPrivilegesResponseSchema
object
3 properties
UserSaveSearchRequestSchema
object
2 properties 1 required
UserTokenLogoutResponseSchema
object
3 properties
UserDeleteSavedSearchResponseSchema
object
3 properties
IsCostSharingFilterV1Schema
object
1 property
UserApplicationListRequestSchema
object
2 properties 1 required
UserApplicationCompetitionSchema
object
6 properties
UserSaveSearchResponseSchema
object
3 properties
AwardFloorFilterV1Schema
object
2 properties
ExperimentalV1Schema
object
1 property
UserGetResponseSchema
object
3 properties
UserApplicationPaginationSchema
object
3 properties 2 required
UserApiKeyCreateResponseSchema
object
3 properties
OrganizationInvitationSchema
object
5 properties
UserApplicationOpportunitySchema
object
3 properties
FundingInstrumentFilterV1Schema
object
1 property
UserSavedOpportunitiesOrganizationIDSFilterSchema
object
1 property
TopLevelAgencyOppSearchFilterV1Schema
object
1 property
UserInvitationListRequestSchema
object
UserOrganizationSchema
object
2 properties
SavedOpportunityResponseV1Schema
object
5 properties
UserCanAccessResponseSchema
object
3 properties
UserApplicationFilterSchema
object
3 properties
SavedOpportunityNotificationsSchema
object
2 properties
UserResponseOrgInvitationRequestSchema
object
1 property
UserInvitationInviterUserSchema
object
4 properties
GetUserRolesAndPrivilegesApplicationSchema
object
2 properties
UserInvitationListResponseSchema
object
3 properties
UserApplicationApplicationStatusFiilterSchema
object
1 property
ApplicantTypeFilterV1Schema
object
1 property
UserOrganization
object
2 properties
UserApiKeyRenameResponseSchema
object
3 properties
OpportunityStatusFilterV1Schema
object
1 property
AgencyOppSearchFilterV1Schema
object
1 property
SortOrderUserGetSavedOpportunityPaginationV1Schema
object
2 properties 2 required
UserInvitationOrganizationSchema
object
2 properties
UserGetSavedOpportunityPaginationV1Schema
object
3 properties 2 required
UserUpdateSavedSearchResponseSchema
object
3 properties
UserApplicationListResponseSchema
object
3 properties
UserInvitationRoleSchema
object
3 properties
UserSchema
object
4 properties
UserDeleteSavedOpportunityResponseSchema
object
3 properties
PostDateFilterV1Schema
object
4 properties
SetUserSavedOpportunityNotificationResponseSchema
object
3 properties
UserApiKeyCreateRequestSchema
object
1 property 1 required
ValidationIssueSchema
object
4 properties
InvitationRoleSchema
object
2 properties
SavedOpportunityNotificationsOrgSchema
object
2 properties
UserSavedSearchesRequestSchema
object
1 property 1 required
SortOrderUserGetSavedSearchPaginationV1Schema
object
2 properties 2 required
EstimatedTotalProgramFundingFilterV1Schema
object
2 properties
UserApiKeyDeleteResponseSchema
object
3 properties
UserSavedSearchesResponseSchema
object
3 properties
UserAgencySchema
object
3 properties
SavedSearchResponseSchema
object
4 properties
UserApplicationListItemSchema
object
5 properties
UserAgency
object
2 properties
AwardCeilingFilterV1Schema
object
2 properties
UserSavedOpportunitiesResponseSchema
object
3 properties
UserTokenRefreshResponseSchema
object
3 properties
GetUserRolesAndPrivilegesOrganizationSchema
object
1 property
SavedOpportunityStatusFieldFilterSchema
object
1 property
UserOrganizationsResponseSchema
object
3 properties
UserSavedOpportunitiesRequestSchema
object
2 properties 1 required
UserApiKeyRenameRequestSchema
object
1 property 1 required
UserInvitationItemSchema
object
7 properties
OpportunitySearchFilterV1Schema
object
14 properties
UserSavedOpportunitiesFilterSchema
object
2 properties
SortOrderUserApplicationPaginationSchema
object
2 properties 2 required
UserUpdateProfileRequestSchema
object
3 properties
UserResponseOrgInvitationResponseSchema
object
3 properties
UserApplicationApplicationCompetitionIDFilterSchema
object
1 property
UserSaveOpportunityRequestSchema
object
1 property 1 required
ExpectedNumberAwardsFilterV1Schema
object
2 properties
UserProfile
object
3 properties
OpportunitySearchRequestV1Schema
object
6 properties 1 required
UserApplicationApplicationOrganizationIDFilterSchema
object
1 property
UserSaveOpportunityResponseSchema
object
3 properties
ErrorResponseSchema
object
5 properties
SamGovEntityResponseSchema
object
6 properties
SetUserSavedOpportunityNotificationRequestSchema
object
2 properties 2 required
UserAgenciesResponseSchema
object
3 properties
UserApiKeySchema
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hhs-user-v1-internal-only-api-openapi.yml Raw ↑

Other APIs HHS (US Department of Health and Human Services) publishes across the network.

openFDA API
AE Profile APIs.io
MyHealthfinder API
AE Profile APIs.io
ONC Health IT Open Data API
AE Profile APIs.io
HRSA Health Center Data Web Service
AE Profile APIs.io
HealthData.gov Catalog API
AE Profile APIs.io
HHS (US Department of Health and Human Services) Agency v1 API
AE Profile APIs.io
HHS (US Department of Health and Human Services) Application Alpha API
AE Profile APIs.io
HHS (US Department of Health and Human Services) Award Recommendation Alpha API
AE Profile APIs.io
HHS (US Department of Health and Human Services) CommonGrants Protocol API
AE Profile APIs.io
HHS (US Department of Health and Human Services) Competition Alpha API
AE Profile APIs.io
HHS (US Department of Health and Human Services) Extract v1 API
AE Profile APIs.io
HHS (US Department of Health and Human Services) File v1 API
AE Profile APIs.io
#User v1 - Internal Only
← Back to H APIs
API Details
ID
hhs:hhs-user-v1-internal-only-api
Base URL
https://api.fda.gov
Docs
https://open.fda.gov/apis/
Provider
HHS (US Department of Health and Human Services)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=hhs-user-v1-internal-only-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/hhs-user-v1-internal-only-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of HHS (US Department of Health and Human Services) User v1 - Internal Only 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.