HHS (US Department of Health and Human Services) Opportunity v1 - for Grantors API

openapi: 3.2.0
info:
  description: '

    Back end API for simpler.grants.gov.


    This API is in active development as we build out new functionalities for Simpler.Grants.gov. It is currently stable for everyday use, and will be versioned with advance notice for any breaking changes.


    Learn more in our [API documentation](https://wiki.simpler.grants.gov/product/api).

    See [Release Phases](https://github.com/github/roadmap?tab=readme-ov-file#release-phases) for further details.

    '
  contact:
    name: Simpler Grants.gov
    url: https://simpler.grants.gov/
    email: simpler@grants.gov
  title: Simpler Grants Opportunity v1 - for Grantors API
  version: v0
servers: .
tags:
- name: Opportunity v1 - for Grantors
paths:
  /v1/grantors/opportunities:
    post:
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityCreateResponseSchema'
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Validation error
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Authentication error
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Internal Server Error
      tags:
      - Opportunity v1 - for Grantors
      summary: Create a new opportunity
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpportunityCreateRequestSchema'
      security:
      - ApiJwtAuth: []
      - ApiUserKeyAuth: []
  /v1/grantors/opportunities/{opportunity_id}:
    get:
      parameters:
      - in: path
        name: opportunity_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityGetResponseSchema'
          description: Successful response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Authentication error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Not found
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Internal Server Error
      tags:
      - Opportunity v1 - for Grantors
      summary: Get an editable opportunity for grantors
      security:
      - ApiJwtAuth: []
      - ApiUserKeyAuth: []
    put:
      parameters:
      - in: path
        name: opportunity_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityUpdateResponseSchema'
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Validation error
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Authentication error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Not found
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Forbidden
      tags:
      - Opportunity v1 - for Grantors
      summary: Update an existing opportunity
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpportunityUpdateRequestSchema'
      security:
      - ApiJwtAuth: []
      - ApiUserKeyAuth: []
  /v1/grantors/agencies/{agency_id}/opportunities:
    post:
      parameters:
      - in: path
        name: agency_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityListResponseSchema'
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Validation error
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Authentication error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Not found
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Internal Server Error
      tags:
      - Opportunity v1 - for Grantors
      summary: Get paginated list of opportunities by agency
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpportunityListRequestSchema'
      security:
      - ApiJwtAuth: []
      - ApiUserKeyAuth: []
  /v1/grantors/opportunities/{opportunity_id}/publish:
    post:
      parameters:
      - in: path
        name: opportunity_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityPublishResponseV1Schema'
          description: Successful response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Authentication error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Not found
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Internal Server Error
      tags:
      - Opportunity v1 - for Grantors
      summary: Publish an opportunity
      security:
      - ApiJwtAuth: []
      - ApiUserKeyAuth: []
  /v1/grantors/opportunities/{opportunity_id}/summaries:
    post:
      parameters:
      - in: path
        name: opportunity_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunitySummaryCreateResponseV1Schema'
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Validation error
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Authentication error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Not found
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Internal Server Error
      tags:
      - Opportunity v1 - for Grantors
      summary: Create a new opportunity summary
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpportunitySummaryCreateRequestV1Schema'
      security:
      - ApiJwtAuth: []
      - ApiUserKeyAuth: []
  /v1/grantors/opportunities/{opportunity_id}/attachments:
    post:
      parameters:
      - in: path
        name: opportunity_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityUploadAttachmentResponseV1Schema'
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Validation error
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Authentication error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Not found
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Internal Server Error
      tags:
      - Opportunity v1 - for Grantors
      summary: Upload an attachment to an opportunity
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OpportunityUploadAttachmentRequestV1Schema'
      security:
      - ApiJwtAuth: []
      - ApiUserKeyAuth: []
  /v1/grantors/opportunities/{opportunity_id}/summaries/{opportunity_summary_id}:
    put:
      parameters:
      - in: path
        name: opportunity_id
        schema:
          type: string
        required: true
      - in: path
        name: opportunity_summary_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunitySummaryUpdateResponseV1Schema'
          description: Successful response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Validation error
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Authentication error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Not found
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Internal Server Error
      tags:
      - Opportunity v1 - for Grantors
      summary: Update an existing opportunity summary
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpportunitySummaryUpdateRequestV1Schema'
      security:
      - ApiJwtAuth: []
      - ApiUserKeyAuth: []
  /v1/grantors/opportunities/{opportunity_id}/attachments/{opportunity_attachment_id}:
    delete:
      parameters:
      - in: path
        name: opportunity_id
        schema:
          type: string
        required: true
      - in: path
        name: opportunity_attachment_id
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAttachmentResponseV1Schema'
          description: Successful response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Authentication error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Not found
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
          description: Internal Server Error
      tags:
      - Opportunity v1 - for Grantors
      summary: Delete an attachment from an opportunity
      security:
      - ApiJwtAuth: []
      - ApiUserKeyAuth: []
components:
  schemas:
    OpportunityListResponseSchema:
      type: object
      properties:
        pagination_info:
          description: The pagination information for paginated endpoints
          type:
          - object
          $ref: '#/components/schemas/PaginationInfoSchema'
        message:
          type: string
          description: The message to return
          example: Success
        data:
          type: array
          description: List of opportunities
          items:
            type:
            - object
            $ref: '#/components/schemas/OpportunityGrantorSchema'
        status_code:
          type: integer
          description: The HTTP status code
          example: 200
    OpportunitySummaryV1Schema:
      type: object
      properties:
        summary_description:
          type:
          - string
          - 'null'
          description: The summary of the opportunity
          example: This opportunity aims to unravel the mysteries of the universe.
        is_cost_sharing:
          type:
          - boolean
          - 'null'
          description: Whether or not the opportunity has a cost sharing/matching requirement
        is_forecast:
          type: boolean
          description: Whether the opportunity is forecasted, that is, the information is only an estimate and not yet official
          example: false
        close_date:
          type:
          - string
          - 'null'
          format: date
          description: The date that the opportunity will close - only set if is_forecast=False
        close_date_description:
          type:
          - string
          - 'null'
          description: Optional details regarding the close date
          example: Proposals are due earlier than usual.
        post_date:
          type:
          - string
          - 'null'
          format: date
          description: The date the opportunity was posted
        archive_date:
          type:
          - string
          - 'null'
          format: date
          description: When the opportunity will be archived
        expected_number_of_awards:
          type:
          - integer
          - 'null'
          description: The number of awards the opportunity is expected to award
          example: 10
        estimated_total_program_funding:
          type:
          - integer
          - 'null'
          description: The total program funding of the opportunity in US Dollars
          example: 10000000
        award_floor:
          type:
          - integer
          - 'null'
          description: The minimum amount an opportunity would award
          example: 10000
        award_ceiling:
          type:
          - integer
          - 'null'
          description: The maximum amount an opportunity would award
          example: 100000
        additional_info_url:
          type:
          - string
          - 'null'
          description: A URL to a website that can provide additional information about the opportunity
          example: grants.gov
        additional_info_url_description:
          type:
          - string
          - 'null'
          description: The text to display for the additional_info_url link
          example: Click me for more info
        forecasted_post_date:
          type:
          - string
          - 'null'
          format: date
          description: Forecasted opportunity only. The date the opportunity is expected to be posted, and transition out of being a forecast
        forecasted_close_date:
          type:
          - string
          - 'null'
          format: date
          description: Forecasted opportunity only. The date the opportunity is expected to be close once posted.
        forecasted_close_date_description:
          type:
          - string
          - 'null'
          description: Forecasted opportunity only. Optional details regarding the forecasted closed date.
          example: Proposals will probably be due on this date
        forecasted_award_date:
          type:
          - string
          - 'null'
          format: date
          description: Forecasted opportunity only. The date the grantor plans to award the opportunity.
        forecasted_project_start_date:
          type:
          - string
          - 'null'
          format: date
          description: Forecasted opportunity only. The date the grantor expects the award recipient should start their project
        fiscal_year:
          type:
          - integer
          - 'null'
          description: Forecasted opportunity only. The fiscal year the project is expected to be funded and launched
        funding_category_description:
          type:
          - string
          - 'null'
          description: Additional information about the funding category
          example: Economic Support
        applicant_eligibility_description:
          type:
          - string
          - 'null'
          description: Additional information about the types of applicants that are eligible
          example: All types of domestic applicants are eligible to apply
        agency_contact_description:
          type:
          - string
          - 'null'
          description: Information regarding contacting the agency who owns the opportunity
          example: For more information, reach out to Jane Smith at agency US-ABC
        agency_email_address:
          type:
          - string
          - 'null'
          description: The contact email of the agency who owns the opportunity
          example: fake_email@grants.gov
        agency_email_address_description:
          type:
          - string
          - 'null'
          description: The text for the link to the agency email address
          example: Click me to email the agency
        version_number:
          type:
          - integer
          - 'null'
          description: The version number of the opportunity summary
          example: 1
        funding_instruments:
          type: array
          items:
            enum:
            - cooperative_agreement
            - grant
            - procurement_contract
            - other
            type:
            - string
        funding_categories:
          type: array
          items:
            enum:
            - recovery_act
            - agriculture
            - arts
            - business_and_commerce
            - community_development
            - consumer_protection
            - disaster_prevention_and_relief
            - education
            - employment_labor_and_training
            - energy
            - environment
            - food_and_nutrition
            - health
            - housing
            - humanities
            - infrastructure_investment_and_jobs_act
            - information_and_statistics
            - income_security_and_social_services
            - law_justice_and_legal_services
            - natural_resources
            - opportunity_zone_benefits
            - regional_development
            - science_technology_and_other_research_and_development
            - transportation
            - affordable_care_act
            - other
            - energy_infrastructure_and_critical_mineral_and_materials
            - recreation_and_tourism
            type:
            - string
        applicant_types:
          type: array
          items:
            enum:
            - state_governments
            - county_governments
            - city_or_township_governments
            - special_district_governments
            - independent_school_districts
            - public_and_state_institutions_of_higher_education
            - private_institutions_of_higher_education
            - federally_recognized_native_american_tribal_governments
            - other_native_american_tribal_organizations
            - public_and_indian_housing_authorities
            - nonprofits_non_higher_education_with_501c3
            - nonprofits_non_higher_education_without_501c3
            - individuals
            - for_profit_organizations_other_than_small_businesses
            - small_businesses
            - other
            - unrestricted
            type:
            - string
        created_at:
          type: string
          format: date-time
          description: When the opportunity summary was created
        updated_at:
          type: string
          format: date-time
          description: When the opportunity summary was last updated
    OpportunityGetResponseSchema:
      type: object
      properties:
        message:
          type: string
          description: The message to return
          example: Success
        data:
          type:
          - object
          $ref: '#/components/schemas/OpportunityGrantorSchema'
        status_code:
          type: integer
          description: The HTTP status code
          example: 200
    FormInstructionSchema:
      type: object
      properties:
        form_instruction_id:
          type: string
          format: uuid
          description: The UUID of the form instruction
          example: 123e4567-e89b-12d3-a456-426614174000
        file_name:
          type: string
          description: The name of the form instruction file
          example: instructions.pdf
        download_path:
          type: string
          description: The download URL for the form instruction file
        created_at:
          type: string
          format: date-time
          description: The timestamp when the form instruction was created
        updated_at:
          type: string
          format: date-time
          description: The timestamp when the form instruction was last updated
    OpportunityListFilterSchema:
      type: object
      properties:
        award_recommendation_ready:
          description: Filter for opportunities ready for award recommendations. Returns only non-draft Simpler Grants opportunities with application submissions and no existing award recommendations.
          type:
          - object
          $ref: '#/components/schemas/AwardRecommendationReadySchema'
    OpportunityPublishResponseV1Schema:
      type: object
      properties:
        message:
          type: string
          description: The message to return
          example: Success
        data:
          type:
          - object
          $ref: '#/components/schemas/OpportunityGrantorSchema'
        status_code:
          type: integer
          description: The HTTP status code
          example: 200
    CompetitionAlphaSchema:
      type: object
      properties:
        competition_id:
          type: string
          format: uuid
          description: The competition ID
          example: 123e4567-e89b-12d3-a456-426614174000
        opportunity_id:
          type: string
          format: uuid
          description: The opportunity ID that the competition is associated with
          example: 123e4567-e89b-12d3-a456-426614174000
        competition_forms:
          type: array
          description: List of forms required for this competition
          items:
            type:
            - object
            $ref: '#/components/schemas/CompetitionFormAlphaSchema'
        competition_instructions:
          type: array
          description: List of instruction files associated with this competition
          items:
            type:
            - object
            $ref: '#/components/schemas/CompetitionInstructionAlphaSchema'
        competition_title:
          type:
          - string
          - 'null'
          description: The title of the competition
          example: Proposal for Advanced Research
        opening_date:
          type:
          - string
          - 'null'
          format: date
          description: The opening date of the competition, the first day applications are accepted
        closing_date:
          type:
          - string
          - 'null'
          format: date
          description: The closing date of the competition, the last day applications are accepted
        contact_info:
          type:
          - string
          - 'null'
          description: Contact info getting assistance with the competition
          example: 'Bob Smith

            FakeMail@fake.com'
        opportunity_assistance_listing:
          description: Assistance listing information for this competition
          type:
          - object
          - 'null'
          anyOf:
          - $ref: '#/components/schemas/OpportunityAssistanceListingV1Schema'
          - type: 'null'
        open_to_applicants:
          type: array
          description: List of applicant types who are eligible for this competition
          example:
          - - individual
          - - organization
          items:
            enum:
            - individual
            - organization
            type:
            - string
        is_open:
          type: boolean
          description: Whether the competition is open and accepting applications
        is_simpler_grants_enabled:
          type: boolean
          description: Whether simpler grants are enabled for this competition
    OpportunityListRequestSchema:
      type: object
      properties:
        pagination:
          description: 'Pagination parameters for opportunity list (default sort: created_at descending)'
          type:
          - object
          $ref: '#/components/schemas/OpportunityListPaginationSchema'
        filters:
          description: Optional filters for opportunity list
          type:
          - object
          $ref: '#/components/schemas/OpportunityListFilterSchema'
      required:
      - pagination
    CompetitionInstructionAlphaSchema:
      type: object
      properties:
        file_name:
          type: string
          description: The name of the instruction file
          example: competition_instructions.pdf
        download_path:
          type: string
          description: The URL to download the instruction file
          example: https://cdn.example.com/competition-instructions/file.pdf
        created_at:
          type: string
          format: date-time
          description: The date and time when the instruction was created
        updated_at:
          type: string
          format: date-time
          description: The date and time when the instruction was last updated
    ValidationIssueSchema:
      type: object
      properties:
        type:
          type: string
          description: The type of error
          example: invalid
        message:
          type: string
          description: The message to return
          example: Not a valid string.
        field:
          type: string
          description: The field that failed
          example: summary.summary_description
        value:
          type: string
          description: The value that failed
          example: invalid string
    SortOrderOpportunityListPaginationSchema:
      type: object
      properties:
        order_by:
          type: string
          enum:
          - opportunity_id
          - opportunity_number
          - opportunity_title
          - created_at
          description: The field to sort the response by
        sort_direction:
          description: Whether to sort the response ascending or descending
          enum:
          - ascending
          - descending
          type:
          - string
      required:
      - order_by
      - sort_direction
    OpportunitySummaryUpdateRequestV1Schema:
      type: object
      properties:
        summary_description:
          type:
          - string
          - 'null'
          maxLength: 18000
          description: Opportunity summary
          example: This opportunity...
        is_cost_sharing:
          type:
          - boolean
          - 'null'
          description: Whether or not the opportunity has a cost sharing/matching requirement
        post_date:
          type: string
          format: date
          description: The date the opportunity was posted
        close_date:
          type:
          - string
          - 'null'
          format: date
          description: The date the opportunity closes
        close_date_description:
          type:
          - string
          - 'null'
          description: Optional details regarding the close date
          example: Proposals are due earlier than usual.
        archive_date:
          type:
          - string
          - 'null'
          format: date
          description: When the opportunity will be archived (defaults to 30 days after the close date)
        expected_number_of_awards:
          type:
          - integer
          - 'null'
          minimum: 0
          maximum: 999999999999999
          description: The number of awards the opportunity is expected to award
          example: 10
        estimated_total_program_funding:
          type:
          - integer
          - 'null'
          minimum: 0
          maximum: 999999999999999
          description: The total program funding of the opportunity in US Dollars
          example: 10000000
        award_floor:
          type:
          - integer
          - 'null'
          minimum: 0
          maximum: 999999999999999
          description: The minimum amount an opportunity would award
          example: 10000
        award_ceiling:
          type:
          - integer
          - 'null'
          minimum: 0
          maximum: 999999999999999
          description: The max

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hhs/refs/heads/main/openapi/hhs-opportunity-v1-for-grantors-api-openapi.yml