> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dataerai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get apigrants

> GET / POST /api/grants/

Filters: ?q (substring on title/grant_id/contact_pi_name),
?registry_source, ?fiscal_year, ?funding_agency_id, ?project_id,
?is_latest (default true; pass false/0/no to include historical versions).



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/grants/
openapi: 3.0.3
info:
  title: Console API
  version: 1.0.0
  description: Central control plane API for the Dataerai platform.
servers:
  - url: https://{server}
    description: Your Dataerai deployment (the API is served under /api)
    variables:
      server:
        default: your-deployment.dataerai.com
        description: Host of your Dataerai deployment
security: []
paths:
  /api/grants/:
    get:
      tags:
        - api
      description: >-
        GET / POST /api/grants/


        Filters: ?q (substring on title/grant_id/contact_pi_name),

        ?registry_source, ?fiscal_year, ?funding_agency_id, ?project_id,

        ?is_latest (default true; pass false/0/no to include historical
        versions).
      operationId: api_grants_list
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GrantRead'
          description: ''
      security:
        - cookieAuthCsrfExempt: []
components:
  schemas:
    GrantRead:
      type: object
      description: |-
        Full read shape; nested funding_agency for client convenience.

        Excludes `search_vector` (binary tsvector — not safe to JSON-serialize).
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        project:
          type: string
          format: uuid
          readOnly: true
          nullable: true
        funding_agency:
          allOf:
            - $ref: '#/components/schemas/FundingAgencyMinimal'
          readOnly: true
        grant_id:
          type: string
          readOnly: true
        registry_source:
          type: string
          readOnly: true
        title:
          type: string
          readOnly: true
        abstract:
          type: string
          readOnly: true
          description: Short structured summary, registry-supplied (e.g. NIH abstract).
        description:
          type: string
          readOnly: true
          description: Long-form public health relevance / lay description.
        funding_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        currency:
          type: string
          readOnly: true
        direct_cost_amt:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        indirect_cost_amt:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        award_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        funding_mechanism:
          type: string
          readOnly: true
        award_type:
          type: string
          readOnly: true
        activity_code:
          type: string
          readOnly: true
        start_date:
          type: string
          format: date
          readOnly: true
          nullable: true
        end_date:
          type: string
          format: date
          readOnly: true
          nullable: true
        fiscal_year:
          type: integer
          readOnly: true
          nullable: true
        url:
          type: string
          format: uri
          readOnly: true
        project_detail_url:
          type: string
          format: uri
          readOnly: true
        extracted_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        raw_data:
          readOnly: true
        appl_id:
          type: integer
          readOnly: true
          nullable: true
        subproject_id:
          type: string
          readOnly: true
        project_num:
          type: string
          readOnly: true
        project_serial_num:
          type: string
          readOnly: true
        core_project_num:
          type: string
          readOnly: true
        project_activity_code:
          type: string
          readOnly: true
        project_suffix_code:
          type: string
          readOnly: true
        mechanism_code_dc:
          type: string
          readOnly: true
        is_active:
          type: boolean
          readOnly: true
        is_new:
          type: boolean
          readOnly: true
        contact_pi_name:
          type: string
          readOnly: true
        agency_ic_admin_code:
          type: string
          readOnly: true
        agency_ic_admin_name:
          type: string
          readOnly: true
        agency_ic_admin_abbrev:
          type: string
          readOnly: true
        cong_dist:
          type: string
          readOnly: true
        geo_lat:
          type: number
          format: double
          readOnly: true
          nullable: true
        geo_lon:
          type: number
          format: double
          readOnly: true
          nullable: true
        spending_category:
          type: string
          readOnly: true
        spending_subcategory:
          type: string
          readOnly: true
        spending_categories_desc:
          type: string
          readOnly: true
        terms:
          type: string
          readOnly: true
        pref_terms:
          type: string
          readOnly: true
        phr_text:
          type: string
          readOnly: true
        covid_response:
          type: string
          readOnly: true
        arra_funded:
          type: string
          readOnly: true
        cfda_code:
          type: string
          readOnly: true
        openalex_id:
          type: string
          readOnly: true
        provenance:
          type: string
          readOnly: true
        funded_outputs_count:
          type: integer
          readOnly: true
          nullable: true
        custom_fields:
          readOnly: true
        version_rev:
          type: integer
          readOnly: true
        is_latest:
          type: boolean
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - abstract
        - activity_code
        - agency_ic_admin_abbrev
        - agency_ic_admin_code
        - agency_ic_admin_name
        - appl_id
        - arra_funded
        - award_amount
        - award_type
        - cfda_code
        - cong_dist
        - contact_pi_name
        - core_project_num
        - covid_response
        - created_at
        - currency
        - custom_fields
        - description
        - direct_cost_amt
        - end_date
        - extracted_at
        - fiscal_year
        - funded_outputs_count
        - funding_agency
        - funding_amount
        - funding_mechanism
        - geo_lat
        - geo_lon
        - grant_id
        - id
        - indirect_cost_amt
        - is_active
        - is_latest
        - is_new
        - mechanism_code_dc
        - openalex_id
        - phr_text
        - pref_terms
        - project
        - project_activity_code
        - project_detail_url
        - project_num
        - project_serial_num
        - project_suffix_code
        - provenance
        - raw_data
        - registry_source
        - spending_categories_desc
        - spending_category
        - spending_subcategory
        - start_date
        - subproject_id
        - terms
        - title
        - url
        - version_rev
    FundingAgencyMinimal:
      type: object
      description: |-
        Minimal funding-agency reference: ``id`` plus display fields
        (``name``, ``abbreviation``).
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 255
        abbreviation:
          type: string
          maxLength: 64
      required:
        - id
        - name

````