Skip to content
Dashier
← All documentation

Dashier docs

Dashier API reference

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

Base path and identifiers

Each data source uses /api/v1/{slug}, where slug is the data-source slug inside a project. A record route appends the record ID: /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

Authentication

Send a project API key as x-api-key: $DASHIER_API_KEY or Authorization: Bearer $DASHIER_API_KEY. 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. A route's Public/Authenticated/Role policy, enabled state, API-exposure setting, 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 to sort by; 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 query parameters return 400. A missing source/record returns 404. Authentication and permission errors use 401/403 as appropriate; 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 in 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.