Skip to main content
POST
/
api
/
grants
/
cURL
curl --request POST \
  --url https://{server}/api/grants/ \
  --header 'Content-Type: application/json' \
  --cookie sessionid= \
  --data '
{
  "grant_id": "<string>",
  "registry_source": "<string>",
  "title": "<string>",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "funding_agency": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "abstract": "<string>",
  "description": "<string>",
  "funding_amount": "<string>",
  "currency": "<string>",
  "direct_cost_amt": "<string>",
  "indirect_cost_amt": "<string>",
  "award_amount": "<string>",
  "funding_mechanism": "<string>",
  "award_type": "<string>",
  "activity_code": "<string>",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "fiscal_year": 0,
  "url": "<string>",
  "project_detail_url": "<string>",
  "appl_id": 0,
  "subproject_id": "<string>",
  "project_num": "<string>",
  "project_serial_num": "<string>",
  "core_project_num": "<string>",
  "project_activity_code": "<string>",
  "project_suffix_code": "<string>",
  "mechanism_code_dc": "<string>",
  "is_active": true,
  "contact_pi_name": "<string>",
  "agency_ic_admin_code": "<string>",
  "agency_ic_admin_name": "<string>",
  "agency_ic_admin_abbrev": "<string>",
  "cong_dist": "<string>",
  "geo_lat": 123,
  "geo_lon": 123,
  "spending_category": "<string>",
  "spending_subcategory": "<string>",
  "spending_categories_desc": "<string>",
  "terms": "<string>",
  "pref_terms": "<string>",
  "phr_text": "<string>",
  "covid_response": "<string>",
  "arra_funded": "<string>",
  "cfda_code": "<string>",
  "openalex_id": "<string>",
  "custom_fields": "<unknown>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "funding_agency": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "abbreviation": "<string>"
  },
  "grant_id": "<string>",
  "registry_source": "<string>",
  "title": "<string>",
  "abstract": "<string>",
  "description": "<string>",
  "funding_amount": "<string>",
  "currency": "<string>",
  "direct_cost_amt": "<string>",
  "indirect_cost_amt": "<string>",
  "award_amount": "<string>",
  "funding_mechanism": "<string>",
  "award_type": "<string>",
  "activity_code": "<string>",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "fiscal_year": 123,
  "url": "<string>",
  "project_detail_url": "<string>",
  "extracted_at": "2023-11-07T05:31:56Z",
  "raw_data": "<unknown>",
  "appl_id": 123,
  "subproject_id": "<string>",
  "project_num": "<string>",
  "project_serial_num": "<string>",
  "core_project_num": "<string>",
  "project_activity_code": "<string>",
  "project_suffix_code": "<string>",
  "mechanism_code_dc": "<string>",
  "is_active": true,
  "is_new": true,
  "contact_pi_name": "<string>",
  "agency_ic_admin_code": "<string>",
  "agency_ic_admin_name": "<string>",
  "agency_ic_admin_abbrev": "<string>",
  "cong_dist": "<string>",
  "geo_lat": 123,
  "geo_lon": 123,
  "spending_category": "<string>",
  "spending_subcategory": "<string>",
  "spending_categories_desc": "<string>",
  "terms": "<string>",
  "pref_terms": "<string>",
  "phr_text": "<string>",
  "covid_response": "<string>",
  "arra_funded": "<string>",
  "cfda_code": "<string>",
  "openalex_id": "<string>",
  "provenance": "<string>",
  "funded_outputs_count": 123,
  "custom_fields": "<unknown>",
  "version_rev": 123,
  "is_latest": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
sessionid
string
cookie
required

Body

User-editable subset.

Ingest-pipeline-owned fields (raw_data, extracted_at, provenance, version_rev, is_latest, is_new, search_vector, funded_outputs_count) are NOT user-editable — they belong to the ingest layer.

​
grant_id
string
required
Maximum string length: 255
​
registry_source
string
required
Maximum string length: 64
​
title
string
required
Maximum string length: 1024
​
project
string<uuid> | null
​
funding_agency
string<uuid> | null
​
abstract
string

Short structured summary, registry-supplied (e.g. NIH abstract).

​
description
string

Long-form public health relevance / lay description.

​
funding_amount
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
currency
string
Maximum string length: 16
​
direct_cost_amt
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
indirect_cost_amt
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
award_amount
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
funding_mechanism
string
Maximum string length: 255
​
award_type
string
Maximum string length: 255
​
activity_code
string
Maximum string length: 64
​
start_date
string<date> | null
​
end_date
string<date> | null
​
fiscal_year
integer<int64> | null
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
url
string<uri>
Maximum string length: 200
​
project_detail_url
string<uri>
Maximum string length: 200
​
appl_id
integer<int64> | null
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
subproject_id
string
Maximum string length: 255
​
project_num
string
Maximum string length: 255
​
project_serial_num
string
Maximum string length: 255
​
core_project_num
string
Maximum string length: 255
​
project_activity_code
string
Maximum string length: 64
​
project_suffix_code
string
Maximum string length: 64
​
mechanism_code_dc
string
Maximum string length: 64
​
is_active
boolean
​
contact_pi_name
string
Maximum string length: 255
​
agency_ic_admin_code
string
Maximum string length: 64
​
agency_ic_admin_name
string
Maximum string length: 255
​
agency_ic_admin_abbrev
string
Maximum string length: 64
​
cong_dist
string
Maximum string length: 64
​
geo_lat
number<double> | null
​
geo_lon
number<double> | null
​
spending_category
string
Maximum string length: 255
​
spending_subcategory
string
Maximum string length: 255
​
spending_categories_desc
string
​
terms
string
​
pref_terms
string
​
phr_text
string
​
covid_response
string
Maximum string length: 255
​
arra_funded
string
Maximum string length: 255
​
cfda_code
string
Maximum string length: 128
​
openalex_id
string
Maximum string length: 64
​
custom_fields
any

Response

201 - application/json

Full read shape; nested funding_agency for client convenience.

Excludes search_vector (binary tsvector — not safe to JSON-serialize).

​
id
string<uuid>
required
read-only
​
project
string<uuid> | null
required
read-only
​
funding_agency
object
required

Nested form for GrantReadSerializer — id + display fields only.

​
grant_id
string
required
read-only
​
registry_source
string
required
read-only
​
title
string
required
read-only
​
abstract
string
required
read-only

Short structured summary, registry-supplied (e.g. NIH abstract).

​
description
string
required
read-only

Long-form public health relevance / lay description.

​
funding_amount
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
currency
string
required
read-only
​
direct_cost_amt
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
indirect_cost_amt
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
award_amount
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
​
funding_mechanism
string
required
read-only
​
award_type
string
required
read-only
​
activity_code
string
required
read-only
​
start_date
string<date> | null
required
read-only
​
end_date
string<date> | null
required
read-only
​
fiscal_year
integer | null
required
read-only
​
url
string<uri>
required
read-only
​
project_detail_url
string<uri>
required
read-only
​
extracted_at
string<date-time> | null
required
read-only
​
raw_data
any
required
​
appl_id
integer | null
required
read-only
​
subproject_id
string
required
read-only
​
project_num
string
required
read-only
​
project_serial_num
string
required
read-only
​
core_project_num
string
required
read-only
​
project_activity_code
string
required
read-only
​
project_suffix_code
string
required
read-only
​
mechanism_code_dc
string
required
read-only
​
is_active
boolean
required
read-only
​
is_new
boolean
required
read-only
​
contact_pi_name
string
required
read-only
​
agency_ic_admin_code
string
required
read-only
​
agency_ic_admin_name
string
required
read-only
​
agency_ic_admin_abbrev
string
required
read-only
​
cong_dist
string
required
read-only
​
geo_lat
number<double> | null
required
read-only
​
geo_lon
number<double> | null
required
read-only
​
spending_category
string
required
read-only
​
spending_subcategory
string
required
read-only
​
spending_categories_desc
string
required
read-only
​
terms
string
required
read-only
​
pref_terms
string
required
read-only
​
phr_text
string
required
read-only
​
covid_response
string
required
read-only
​
arra_funded
string
required
read-only
​
cfda_code
string
required
read-only
​
openalex_id
string
required
read-only
​
provenance
string
required
read-only
​
funded_outputs_count
integer | null
required
read-only
​
custom_fields
any
required
​
version_rev
integer
required
read-only
​
is_latest
boolean
required
read-only
​
created_at
string<date-time>
required
read-only