Data model

Pilot leads

Pilot / partner / LOI-source contact tracked in the Partners kanban. Keyed to a grant; state moves lead → talking → loi_draft → loi_signed → lost.

Model name: lead

Endpoints: 5

Max page size: 500

Fields

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

Field	Type	Constraints
org	`string`
size	`string`	max length`100`
notes	`string`	max length`2000`
state	`enum`	enum`lead \| talking \| loi_draft \| loi_signed \| lost`
region	`string`	max length`100`
contact	`string`	max length`200`
grant_id	`string`	max length`64`ref →`grant`
loi_signed_at	`string`	max length`32`

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
org	string
size	string
notes	string
state	enum
region	string
contact	string
grant_id	string
loi_signed_at	string
first_name	-
last_name	-
gender	-
company	-
position	-
fair_location	-
phone	-
email	-
linkedin	-
website	-
city	-
country	-
lead_status	-
note	-
tags	-
inferred_gender	-
inferred_country	-
inferred_domain	-
account_id	-
lead_source_id	-
last_contacted_at	-

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

first_namedata__first_name

last_namedata__last_name

companydata__company

emaildata__email

phonedata__phone

citydata__city

countrydata__country

lead_statusdata__lead_status

tagsdata__tags

genderdata__gender

inferred_countrydata__inferred_country

inferred_genderdata__inferred_gender

inferred_domaindata__inferred_domain

account_iddata__account_id

lead_source_iddata__lead_source_id

statusstatus

is_archivedis_archived

owned_byowned_by

created_bycreated_by

Sort keys

created_atcreated_at

updated_atupdated_at

first_namedata__first_name

last_namedata__last_name

companydata__company

lead_statusdata__lead_status

last_contacted_atdata__last_contacted_at

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/leadlead: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/lead?limit=20"

GET/xapi2/data/lead/{id}lead: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/lead/OBJECT_ID

POST/xapi2/data/leadlead: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/lead \
     -d '{"name": "…"}'

PATCH/xapi2/data/lead/{id}lead: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/lead/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/lead/{id}lead: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/lead/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 lead list --limit 5
grantscli lead get <id>
grantscli lead create --first-name "Hello"
grantscli lead upsert --unique first_name --csv items.csv
grantscli lead schema   # fields & limits

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