Data model

Grants

A grant application workspace. Owns its file tree (folders and files). Carries funder/program metadata and tracks submission lifecycle.

Model name: grant

Endpoints: 5

Max page size: 200

Fields

Per-field validation rules. Values that violate any constraint are rejected with 400 before they reach the database.

Field	Type	Constraints
tags	`tags`	-
color		max length`24`
notes	`string`	max length`4000`
title	`string`	max length`300`
status	`enum`	enum`drafting \| submitted \| under_review \| awarded \| rejected \| abandoned`
program	`string`	max length`200`
currency	`string`	max length`8`
deadline	`string`	max length`32`
team_size	`number`	-
description	`string`	max length`2000`
root_file_id	`string`	max length`64`
grant_type_key	`string`	max length`64`
requested_amount	`number`	-

Mutability

Which fields can you send, and when? Anything without a marker is server-managed - sending it isn't an error, it's silently ignored.

Create-only - read from POST body.Patchable - read from PATCH body.Server-managed - ignored on the body.

Field	Type	Create	Patch
tags	tags
color	string
notes	string
title	string
status	enum
program	string
currency	string
deadline	string
team_size	number
description	string
root_file_id	string
grant_type_key	string
requested_amount	number
funder	-
compiler	-
intake_blob_id	-
intake_url	-
intake_extracted	-
import_status	-
import_started_at	-
import_finished_at	-
intake_extracted_by_source	-
intake_sources	-
awarded_amount	-
awarded_at	-
profile	-
baseline_score	-
spellcheck_language_override	-
spellcheck_whitelist	-
spellcheck_disabled_rules	-

Fields marked create-only but not patchable are immutable after creation. Server-managed fields include id, timestamps, ownership, and status.

Filtering & sorting

Combinable on list endpoints. Repeating a filter key produces an IN clause; prefixing a sort key with - reverses direction. Example: ?status=open&status=blocked&sort=-created_at.

Filter keys

statusdata__status

funderdata__funder

tagsdata__tags

deadlinedata__deadline

grant_type_keydata__grant_type_key

statusstatus

is_archivedis_archived

owned_byowned_by

Sort keys

created_atcreated_at

updated_atupdated_at

titledata__title

deadlinedata__deadline

statusdata__status

Default: created_at

Endpoints

Each endpoint below lists its HTTP method, path, and the PAT scope it needs. Code samples cover curl, JavaScript, TypeScript, Python, Rust, Java, and WebSocket.

GET/xapi2/data/grantgrant:list

List objects

Returns a paginated list of objects you can read. Default page size is 20; pass ?limit= to change (capped per type). Use ?after=<id> for keyset pagination on created_at-sorted lists, or ?offset= for offset paging.

curl -H "Authorization: Bearer pat_…" \
     "https://granttool.de/xapi2/data/grant?limit=20"

GET/xapi2/data/grant/{id}grant:read

Read one

Returns the object by id. 404 if it does not exist or you cannot read it (the two cases are intentionally conflated).

curl -H "Authorization: Bearer pat_…" \
     https://granttool.de/xapi2/data/grant/OBJECT_ID

POST/xapi2/data/grantgrant:create

Create

Creates a new object. Body is a flat JSON dict of field values. Server-side fields (id, timestamps, ownership) are filled automatically; only fields listed below as creatable are read from the body.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X POST https://granttool.de/xapi2/data/grant \
     -d '{"name": "…"}'

PATCH/xapi2/data/grant/{id}grant:update

Update

Partial update. Only fields included in the body are touched; everything else is preserved. Same allow-list as create, minus the fields that are immutable post-create.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X PATCH https://granttool.de/xapi2/data/grant/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/grant/{id}grant:delete

Delete

Removes the object. It vanishes from every default list immediately and stops being returned by read / list.

curl -H "Authorization: Bearer pat_…" \
     -X DELETE https://granttool.de/xapi2/data/grant/OBJECT_ID

Use in CLI

The same endpoints are also exposed via the Grants CLI. For scripts, CI, and bulk imports it's usually the faster path.

grantscli grant list --limit 5
grantscli grant get <id>
grantscli grant create --grant-type-key "Hello"
grantscli grant upsert --unique grant_type_key --csv items.csv
grantscli grant schema   # fields & limits

Full command reference, profiles, CSV import, auto-retry, NDJSON streaming → /docs/cli