Skip to content
← All documentation

Dashier documentation

Dashier API reference

Collection and record routes, query parameters, headers, and common response codes.

Base path and identifiers

Each source uses /api/v1/{slug}, where slug is the source slug inside a project. Append a record ID for /api/v1/{slug}/{id}. The source and its fields must exist before a request can succeed.

Methods

MethodPathAction
GET/api/v1/{slug}List records
POST/api/v1/{slug}Create a validated record
GET/api/v1/{slug}/{id}Retrieve one record
PUT/api/v1/{slug}/{id}Update a record
DELETE/api/v1/{slug}/{id}Delete a record
GET/api/v1/{slug}/schemaDescribe the source (JSON Schema + TypeScript)

Schema documents

GET /api/v1/{slug}/schema returns data.source, data.recordschema, data.createschema, data.typescript, and a data.fields summary. The record schema describes stored data, including read-only generated identifiers and auto-generated timestamps; the create schema omits every server-owned field. Reference properties carry an x-reference block with the target source, stored source key, and display label. Enum properties list the allowed keys with x-labels. Field definitions added after integrations exist can add keys and enum values, so treat schema documents as the current contract rather than a frozen one.

Authentication

Send a project key as x-api-key: $DASHIERAPIKEY or Authorization: Bearer $DASHIERAPIKEY. Keys use read, write, or admin scopes. Without a key, the resolver asks for organization/project slugs and can associate a signed-in organization member with the request. Public/Authenticated/Role policy, route enabled state, API exposure, scope, and rate limit still apply.

List parameters

  • page: one-based page number, default 1.
  • per_page: 1 to 100, default 20.
  • search: text search across searchable fields, up to 200 characters.
  • sort: field key; dir is asc or desc.
  • filter_{field}: exact filter value for a field key.

A collection response includes data, total, page, and per_page. POST and PUT require a JSON object; field validation errors may return 422. Invalid queries return 400, a missing source or record returns 404, authentication/permission errors use 401/403, and rate limiting returns 429 with limit/retry headers.

Example

curl -H "Authorization: Bearer $DASHIER_API_KEY" "$DASHIER_ORIGIN/api/v1/members?filter_status=active&page=1&per_page=20"

Keep keys in a server-only secret store, not a public frontend, application bundle, or mobile client. Treat delete as irreversible in your own workflow and confirm authorization behavior before production. These are the routes implemented in the current repository; no GraphQL endpoint or generated SDK is documented.