Blackbaud Applications API

openapi: 3.2.0
info:
  title: 'Blackbaud SKY API: GrantsConnect Applications API'
  description: This API provides access to read and update data within GrantsConnect.
  version: '1.0'
  x-apievangelist-provenance:
    source: https://developer.sky.blackbaud.com/developer/apis/grants-connect
    method: assembled from Blackbaud's public API Management developer data API (operations, parameters, representations, examples, stored definitions); nothing authored
    assembled: '2026-10-14'
servers:
- url: https://api.sky.blackbaud.com/grants-connect
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Applications
paths:
  /v1/applications/search:
    post:
      operationId: SearchApplications
      summary: Search applications (PREVIEW)
      description: 'Retrieves information about applications.


        ***This endpoint is in PREVIEW and may be changed or removed at any time.***'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplyApplicationSearchFilters'
            example:
              application_ids:
              - 1001
              - 1002
              - 1003
              program_id: 2001
              nonprofit_guid: c8a84f69-645e-4d7b-951a-4b546b70bd93
              include_draft_applications: true
              limit: 50
              page: 1
              date_modified: '2025-01-01T12:00:00Z'
              include_inactive: false
        description: Specifies the conditions of the applications to search. If no filter is provided, the response will only include updates made within the last day.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnPaginatedApplicationRecords'
              example:
                records:
                - draft: false
                  archived: false
                  amount_requested: 1000
                  currency_requested: USD
                  reserved_funds: true
                  grant_program:
                    id: 1
                    name: Sample Grant Program
                    grant_program_guid: 00000000-0000-0000-0000-000000000000
                  organization_details:
                    id: 1
                    name: Sample Organization
                  budget:
                    id: 1
                    name: Sample Budget
                  inactive: false
                  created_by_user:
                    user_id: 2001
                    first_name: John
                    last_name: Smith
                    email: john.smith@example.com
                  status_modified_by_name: John Doe
                  status_modified_by_email: john.doe@example.com
                  status_modified_date: '2025-01-01T12:00:00Z'
                  status_modified_by_user_id: 123
                  status_comment: Application submitted successfully.
                  application_guid: c8a84f69-645e-4d7b-951a-4b546b70bd93
                  main_applicant_details:
                    id: 1001
                    user_id: 12345
                    first_name: Jane
                    last_name: Doe
                    email: jane.doe@example.com
                  workflow_level_details:
                    id: 1
                    name: Initial Review
                    description: First level of workflow for application review
                  days_in_workflow_level: 5
                  last_submitted_form_id: 3001
                  id: 1
                  submitted_date: '2025-01-01T12:00:00Z'
                  application_status: InProgress
                  nonprofit_guid: d1a84f69-645e-4d7b-951a-4b546b70bd93
                record_count: 1
      tags:
      - Applications
  /v1/applications/{application_id}/applicants:
    get:
      operationId: GetApplicationApplicants
      summary: Get applicants (PREVIEW)
      description: 'Retrieves information about the applicants and collaborators for an application.


        ***This endpoint is in PREVIEW and may be changed or removed at any time.***'
      parameters:
      - name: application_id
        in: path
        required: true
        schema:
          type: integer
        description: The identifier of the application.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApplicantInformation'
              example:
                collaborators:
                - id: 1
                  email: jane.doe@example.com
                  first_name: Jane
                  last_name: Doe
                  user_id: 12345
                  applicant_type: Collaborator
      tags:
      - Applications
  /v1/applications/{application_id}/fileuploads:
    get:
      operationId: GetApplicationFileUploads
      summary: Get file uploads for an application (PREVIEW)
      description: 'Retrieves information about the file uploads for an application.


        ***This endpoint is in PREVIEW and may be changed or removed at any time.***'
      parameters:
      - name: application_id
        in: path
        required: true
        schema:
          type: integer
        description: The identifier of the application.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnApplicationFileDetails'
              example:
                files:
                - file_upload_id: 1000
                  file_name: example.docx
                  file_type: External
                - file_upload_id: 1001
                  file_name: example.pdf
                  file_type: MergeDocument
      tags:
      - Applications
  /v1/applications/{application_id}/fileuploads/{file_upload_id}:
    get:
      operationId: GetApplicationFileUpload
      summary: Download an application (PREVIEW)
      description: 'Retrieves a temporary URL to download an application in PDF format.


        ***This endpoint is in PREVIEW and may be changed or removed at any time.***'
      parameters:
      - name: application_id
        in: path
        required: true
        schema:
          type: integer
        description: The identifier of the application.
      - name: file_upload_id
        in: path
        required: true
        schema:
          type: integer
        description: The identifier of the file upload.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFile'
              example:
                uri: https://example.com/files/example.pdf
                file_name: example.pdf
      tags:
      - Applications
  /v1/applications/{application_id}/forms:
    get:
      operationId: GetApplicationForms
      summary: Get application forms (PREVIEW)
      description: 'Retrieves information about application forms.


        ***This endpoint is in PREVIEW and may be changed or removed at any time.***'
      parameters:
      - name: application_id
        in: path
        required: true
        schema:
          type: integer
        description: The identifier of the application.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApplicationForms'
              example:
                application_forms:
                - name: Sample Application Form
                  form_type: Request
                  inactive: false
                  application_form_id: 12345
                  form_id: 54321
                  form_revision_id: 98765
                  draft: false
                  submitted_date: '2025-01-01T12:00:00Z'
                  last_resubmit_date: '2025-01-01T12:00:00Z'
                  application_form_status_id: Sent
                  status_modified_by_user_id: 100
                  status_modified_date: '2025-01-01T12:00:00Z'
                  application_form_revision_request_id: 67890
                  due_date: '2025-01-01T12:00:00Z'
                  workflow_level_id: 1
                  decision: Approve
                  application_guid: c8a84f69-645e-4d7b-951a-4b546b70bd93
      tags:
      - Applications
  /v1/applications/{application_id}/inkinditems:
    get:
      operationId: GetApplicationInKindItems
      summary: Get in-kind items for an application (PREVIEW)
      description: 'Retrieves information about the in-kind items awarded for a specific application.


        ***This endpoint is in PREVIEW and may be changed or removed at any time.***'
      parameters:
      - name: application_id
        in: path
        required: true
        schema:
          type: integer
        description: The identifier of the application.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApplicationInKindItems'
              example:
                application_in_kind_items:
                - id: 1
                  item_identification: Item 1
                  count: 2
                  value: 100
                  units: 10
      tags:
      - Applications
components:
  schemas:
    GetApplicationInKindItems:
      type: object
      properties:
        application_in_kind_items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReturnInKindItems'
          description: The in-kind items in the award.
      additionalProperties: false
      description: Returns information about the in-kind items requested for an application.
    FormType:
      enum:
      - Request
      - Eligibility
      - LetterOfIntentOrInquiry
      - Review
      - Award
      - Approve
      - Decline
      - Payment
      - ProgressReport
      - GrantAgreement
      - SiteVisit
      - MeetingNotes
      - AdditionalDocumentation
      - Approval
      - OtherApplicantForm
      - OtherGrantManagerForm
      - Nomination
      - GrantProgramRouting
      type: string
      description: Defines the types of forms<p>Available values:</p><ul><li><i>Request</i></li><li><i>Eligibility</i></li><li><i>LetterOfIntentOrInquiry</i></li><li><i>Review</i></li><li><i>Award</i></li><li><i>Approve</i></li><li><i>Decline</i></li><li><i>Payment</i></li><li><i>ProgressReport</i></li><li><i>GrantAgreement</i></li><li><i>SiteVisit</i></li><li><i>MeetingNotes</i></li><li><i>AdditionalDocumentation</i></li><li><i>Approval</i></li><li><i>OtherApplicantForm</i></li><li><i>OtherGrantManagerForm</i></li><li><i>Nomination</i></li><li><i>GrantProgramRouting</i></li></ul>
    ApplyApplicationSearchFilters:
      type: object
      properties:
        application_ids:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
          description: If provided, results will filter on the identifier of the application. Separate multiple IDs with a comma to query more than one application.
        program_id:
          maximum: 2147483647
          minimum: 1
          type:
          - integer
          - 'null'
          description: 'If provided, results will filter on the identifier of the grant or nomination program.

            Only applications for this grant or nomination program will be returned.'
          format: int32
        nonprofit_guid:
          type:
          - string
          - 'null'
          description: If provided, results will filter on the unique identifier for the organization. Only applications for this organization will be returned.
          format: uuid
          x-bb-suppressions:
          - parameter_property_name
        include_draft_applications:
          type: boolean
          description: Specifies if applications with a draft status should be returned. Value is true or false.
          default: true
        limit:
          maximum: 500
          minimum: 50
          type: integer
          description: Specifies the maximum number of records to return per page.
          format: int32
          default: 50
        page:
          maximum: 2147483647
          minimum: 1
          type: integer
          description: Specifies the page number for pagination.
          format: int32
          default: 1
        date_modified:
          type:
          - string
          - 'null'
          description: If provided, only records modified since the date and time specified will be returned. Time zone is UTC.
          format: date-time
        include_inactive:
          type: boolean
          description: Specifies if inactive records should be returned. Value is true or false.
          default: false
      additionalProperties: false
      description: Filters to apply to the search. Specify conditions of the applications to return detailed information.
    ReturnBasicApplicantDetails:
      type: object
      properties:
        id:
          type: integer
          description: The identifier of the applicant.
          format: int32
        user_id:
          type: integer
          description: The identifier of the user.
          format: int32
        first_name:
          type:
          - string
          - 'null'
          description: The first name of the user.
        last_name:
          type:
          - string
          - 'null'
          description: The last name of the user.
        email:
          type:
          - string
          - 'null'
          description: The email of the user.
      additionalProperties: false
      description: Basic information about the applicant that submitted the application.
    ReturnApplicationFileDetails:
      type: object
      properties:
        files:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReturnApplicationFile'
          description: The files associated to the application.
      additionalProperties: false
      description: Returns information about the files uploaded for an application.
    ReturnPaginatedApplicationRecords:
      type: object
      properties:
        records:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ApplicationInformationQueryResults'
          description: The details returned for the current page.
        record_count:
          type:
          - integer
          - 'null'
          description: The total number of records in the search result.
          format: int32
      additionalProperties: false
      description: Returns a paginated view of applications.
    ApplicationFileType:
      enum:
      - Email
      - Form
      - External
      - MergeDocument
      - Communication
      - SignedDocument
      type: string
      description: The types of files that may be associated to an application.<p>Available values:</p><ul><li><i>Email</i></li><li><i>Form</i></li><li><i>External</i></li><li><i>MergeDocument</i></li><li><i>Communication</i></li><li><i>SignedDocument</i></li></ul>
    ReturnApplicationFile:
      type: object
      properties:
        file_upload_id:
          type: integer
          description: The ID of the file upload.
          format: int32
        file_name:
          type:
          - string
          - 'null'
          description: The name of the file upload.
        file_type:
          $ref: '#/components/schemas/ApplicationFileType'
      additionalProperties: false
      description: Returns information about an application file upload.
    ReturnBasicBudgetDetails:
      type: object
      properties:
        id:
          type: integer
          description: The identifier of the budget.
          format: int32
        name:
          type:
          - string
          - 'null'
          description: The name of the budget.
      additionalProperties: false
      description: Basic information about the budget assigned to the application.
    ReturnApplicationFormInformation:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: The name of the application form.
        form_type:
          $ref: '#/components/schemas/FormType'
        inactive:
          type: boolean
          description: Indicates if the form is inactive. Value is true or false.
        application_form_id:
          type: integer
          description: The identifier of the form in the application.
          format: int32
        form_id:
          type: integer
          description: The identifier of the form. This ID is not specific to the application.
          format: int32
        form_revision_id:
          type: integer
          description: The revision ID of the application form.
          format: int32
        draft:
          type: boolean
          description: Indicates if the application form has been submitted. If true, the form is still in a draft status. If false, the form has been submitted.
        submitted_date:
          type:
          - string
          - 'null'
          description: The date and time the application form was submitted. Time zone is UTC.
          format: date-time
        last_resubmit_date:
          type:
          - string
          - 'null'
          description: The date and time of the last time the application form was submitted, including resubmissions based on revision requests. Time zone is UTC.
          format: date-time
        application_form_status_id:
          $ref: '#/components/schemas/ApplicationFormStatus'
        status_modified_by_user_id:
          type:
          - integer
          - 'null'
          description: The identifier of the user who last modified the status of the application form.
          format: int32
        status_modified_date:
          type:
          - string
          - 'null'
          description: The date and time the status of the application form was last modified. Time zone is UTC.
          format: date-time
          x-bb-suppressions:
          - parameter_property_name
        application_form_revision_request_id:
          type:
          - integer
          - 'null'
          description: The identifier of the revision request for this application form.
          format: int32
        due_date:
          type:
          - string
          - 'null'
          description: The date and time by which the applicant must submit the application form.
          format: date-time
        workflow_level_id:
          type:
          - integer
          - 'null'
          description: The identifier of the workflow level.
          format: int32
        decision:
          $ref: '#/components/schemas/FormDecisionTypes'
        application_guid:
          type: string
          description: The unique identifier for the application.
          format: uuid
          x-bb-suppressions:
          - parameter_property_name
      additionalProperties: false
      description: Detailed information about the application forms.
    ReturnBasicWorkflowLevelDetails:
      type: object
      properties:
        id:
          type: integer
          description: The identifier of the workflow level.
          format: int32
        name:
          type:
          - string
          - 'null'
          description: The name of the workflow level.
        description:
          type:
          - string
          - 'null'
          description: The description of the workflow level.
      additionalProperties: false
      description: Basic information about the workflow level.
    GetFile:
      type: object
      properties:
        uri:
          type:
          - string
          - 'null'
          description: The URI that can be used to access the file.
        file_name:
          type:
          - string
          - 'null'
          description: The name of the file.
      additionalProperties: false
      description: Contains details that can be used to access a file.
    ApplicationFormStatus:
      enum:
      - NotSent
      - Sent
      - Draft
      - Submitted
      - RevisionRequested
      type: string
      description: The statuses for an application form.<p>Available values:</p><ul><li><i>NotSent</i></li><li><i>Sent</i></li><li><i>Draft</i></li><li><i>Submitted</i></li><li><i>RevisionRequested</i></li></ul>
    ReturnBasicGrantProgramDetails:
      type: object
      properties:
        id:
          type: integer
          description: The identifier of the grant program.
          format: int32
        name:
          type:
          - string
          - 'null'
          description: The name of the grant program.
        description:
          type:
          - string
          - 'null'
          description: The description of the grant program.
        guidelines:
          type:
          - string
          - 'null'
          description: The program guidelines, if any.
          x-bb-suppressions:
          - parameter_property_name
        grant_program_guid:
          type: string
          description: A unique identifier for the grant program.
          format: uuid
          x-bb-suppressions:
          - parameter_property_name
      additionalProperties: false
      description: Basic information about the grant program.
    GetApplicantInformation:
      type: object
      properties:
        collaborators:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReturnApplicantInformation'
          description: The main applicant and additional collaborators for the application.
      additionalProperties: false
      description: Returns information about the main applicant and additional collaborators.
    ReturnInKindItems:
      type: object
      properties:
        id:
          type: integer
          description: The identifier of the in-kind item.
          format: int32
        item_identification:
          type:
          - string
          - 'null'
          description: The identification for the in-kind item. This may be a combination of text and numbers.
        count:
          type: integer
          description: The number of in-kind items included in the award.
          format: int32
        value:
          type: number
          description: The monetary value of a single in-kind item.
          format: double
        units:
          type:
          - integer
          - 'null'
          description: The total number of units for this in-kind item that are available for awards and payments.
          format: int32
      additionalProperties: false
      description: Detailed information about the in-kind items awarded, including item ID, count, monetary value, and units.
    ReturnBasicUserDetails:
      type: object
      properties:
        user_id:
          type: integer
          description: The identifier of the user.
          format: int32
        first_name:
          type:
          - string
          - 'null'
          description: The first name of the user.
        last_name:
          type:
          - string
          - 'null'
          description: The last name of the user.
        email:
          type:
          - string
          - 'null'
          description: The email of the user.
      additionalProperties: false
      description: Basic information about a user. This may be an applicant or a Grant Manager user.
    ApplicationApplicantType:
      enum:
      - Main
      - Collaborator
      type: string
      description: The types of applicants/collaborators on an application.<p>Available values:</p><ul><li><i>Main</i></li><li><i>Collaborator</i></li></ul>
    GetApplicationForms:
      type: object
      properties:
        application_forms:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReturnApplicationFormInformation'
          description: The forms in the application.
      additionalProperties: false
      description: Returns information about application forms.
    ApplicationStatus:
      enum:
      - AwaitingReview
      - InProgress
      - Approved
      - Declined
      - Hold
      - Cancelled
      - Draft
      type: string
      description: The steps in an application's lifecycle<p>Available values:</p><ul><li><i>AwaitingReview</i></li><li><i>InProgress</i></li><li><i>Approved</i></li><li><i>Declined</i></li><li><i>Hold</i></li><li><i>Cancelled</i></li><li><i>Draft</i></li></ul>
    ApplicationInformationQueryResults:
      type: object
      properties:
        draft:
          type: boolean
          description: Indicates if the application is in a draft status. Value is true or false.
        archived:
          type: boolean
          description: Indicates if the application has been archived. Value is true or false.
        amount_requested:
          type: number
          description: The monetary value requested by the applicant. Cash payments only.
          format: double
        currency_requested:
          type:
          - string
          - 'null'
          description: The currency requested by the applicant.
        reserved_funds:
          type: boolean
          description: Indicates if funds have been reserved from the budget. Value is true or false.
        grant_program:
          $ref: '#/components/schemas/ReturnBasicGrantProgramDetails'
        organization_details:
          $ref: '#/components/schemas/ReturnBasicOrganizationDetails'
        budget:
          $ref: '#/components/schemas/ReturnBasicBudgetDetails'
        inactive:
          type: boolean
          description: Indicates if the application is inactive. Value is true or false.
        created_by_user:
          $ref: '#/components/schemas/ReturnBasicUserDetails'
        status_modified_by_name:
          type:
          - string
          - 'null'
          description: The name of the user who last modified the application status. This attribute is not available for applications created after May 2023.
          x-bb-suppressions:
          - parameter_property_name
        status_modified_by_email:
          type:
          - string
          - 'null'
          description: The email address of the user who last modified the application status. This attribute is not available for applications created after May 2023.
          x-bb-suppressions:
          - parameter_property_name
        status_modified_date:
          type:
          - string
          - 'null'
          description: The date and time the application status was last modified. Time zone is UTC.
          format: date-time
          x-bb-suppressions:
          - parameter_property_name
        status_modified_by_user_id:
          type:
          - integer
          - 'null'
          description: The identifier of the user who last modified the application status. This attribute is not available for applications created after May 2023.
          format: int32
        status_comment:
          type:
          - string
          - 'null'
          description: The comment provided by the Grant Manager when the application status was changed.
        application_guid:
          type: string
          description: The unique identifier for the application.
          format: uuid
          x-bb-suppressions:
          - parameter_property_name
        main_applicant_details:
          $ref: '#/components/schemas/ReturnBasicApplicantDetails'
        workflow_level_details:
          $ref: '#/components/schemas/ReturnBasicWorkflowLevelDetails'
        days_in_workflow_level:
          type: integer
          description: The number of days the application has been in the current workflow level.
          format: int32
        last_submitted_form_id:
          type:
          - integer
          - 'null'
          description: The identifier of the application form that was last submitted.
          format: int32
        id:
          type: integer
          description: The identifier of the application.
          format: int32
        submitted_date:
          type:
          - string
          - 'null'
          description: The date and time the application was submitted. Time zone is UTC.
          format: date-time
        application_status:
          $ref: '#/components/schemas/ApplicationStatus'
        nonprofit_guid:
          type:
          - string
          - 'null'
          description: The unique identifier for the organization.
          format: uuid
          x-bb-suppressions:
          - parameter_property_name
      additionalProperties: false
      description: Detailed information about applications. Results are filtered by search criteria, if provided.
    FormDecisionTypes:
      enum:
      - Approve
      - Deny
      - Recused
      type: string
      description: The types of decisions that can be made on a form<p>Available values:</p><ul><li><i>Approve</i></li><li><i>Deny</i></li><li><i>Recused</i></li></ul>
    ReturnApplicantInformation:
      type: object
      properties:
        id:
          type: integer
          description: The identifier of the applicant.
          format: int32
        email:
          type:
          - string
          - 'null'
          description: The email address of the applicant.
        first_name:
          type:
          - string
          - 'null'
          description: The first name of the applicant.
        last_name:
          type:
          - string
          - 'null'
          description: The last name of the applicant.
        user_id:
          type: integer
          description: The user ID of the applicant.
          format: int32
        applicant_type:
          $ref: '#/components/schemas/ApplicationApplicantType'
      additionalProperties: false
      description: Detailed information about the main applicant and additional collaborators.
    ReturnBasicOrganizationDetails:
      type: object
      properties:
        id:
          type: integer
          description: The identifier of the organization.
          format: int32
        name:
          type:
          - string
          - 'null'
          description: The name of the organization.
        registration_name:
          type:
          - string
          - 'null'
          description: The government tax identification number issued to the organization by their government agency or registration authority. Examples include EIN, Tax ID, VAT, BN, or PAN.
        address1:
          type:
          - string
          - 'null'
          description: The primary address for the organization, including building number and street name.
        address2:
          type:
          - string
          - 'null'
          description: Additional address information, such as unit number or PO Box.
        city:
          type:
          - string
          - 'null'
          description: The city where the organization is based.
        postal_code:
          type:
          - string
          - 'null'
          description: The postal code where the organization is based.
        state:
          type:
          - string
          - 'null'
          description: The state where the organization is based.
        country:
          type:
          - string
          - 'null'
          description: The country where the organization is based.
      additionalProperties: false
      description: Basic information about the organization that submitted the application.
  securitySchemes:
    Bb-Api-Subscription-Key:
      type: apiKey
      name: Bb-Api-Subscription-Key
      in: header
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.blackbaud.com/oauth/authorize
          tokenUrl: https://oauth2.sky.blackbaud.com/token
          scopes: {}