GraphQL API overview

The GraphQL API is Darpan’s external, read-only API. An API key belongs to one tenant, and every query reads only that tenant’s data.


Endpoint	`POST https://api.drpn.ai/rest/s1/graphql/public` on hosted Darpan; a self-hosted instance uses its own backend URL
Schema (SDL)	`GET https://api.drpn.ai/rest/s1/graphql/sdl`, no key needed
Authentication	An API key in the `Authorization: Bearer dgql_…` header. See Authentication
Operations	Queries only. A mutation is rejected

New here? Test your API key takes five minutes. To find the right query for a question, start from Common tasks.

What you can read

You want	Query
This morning’s audit: can it be trusted, what is open, every statement	`auditReport`
One finding in full: records, evidence, fix, history	`auditFinding`
Every finding, filtered and paged	`findings`
Reconciliation runs, newest first, or one by id	`reconciliationResults`, `reconciliationResult`

The audit queries return the same documents as Darpan’s JSON (darpan.audit.report/v1, darpan.audit.finding/v1), with one difference: GraphQL has no maps with dynamic keys, so a keyed object in the JSON is a list here, and each element carries its key (categories: [{ id: "orders", … }]).

Make a request

curl -s https://api.drpn.ai/rest/s1/graphql/public \
  -H "Authorization: Bearer $DARPAN_GQL_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ auditReport(audit: \"month-close\") { health { complete summary } summary { open pending } } }"}'

Every response has the same envelope: data, errors and extensions.cost. See Errors and Cost and throttling. To send it without a terminal, use the API explorer.

Fixing what a finding reports

The API has no mutations. Fix a record in the system it lives in (NetSuite, the OMS, Shopify) with your own tools. Darpan’s next scheduled check looks at the record again and closes the finding when the check no longer reports it.

JSON-RPC

/rpc/json is the API of Darpan’s own app. It is internal and not documented here. Integrations use GraphQL.

Get started

Common tasks

Using the API

Queries

Objects

What you can read

Make a request

Fixing what a finding reports

JSON-RPC

​What you can read

​Make a request

​Fixing what a finding reports

​JSON-RPC

What you can read

Make a request

Fixing what a finding reports

JSON-RPC