Violet Explore API

REST API for programmatic access to your Violet data. The Explore endpoint (POST /api/explore) accepts a rich query payload (keyword, filterModel, sort, grouping, pagination) and returns a paginated PageDto of entities. Authenticated with an x-api-key header. The API is served per-tenant at https://{tenant}.violetlabs.com/api (or {tenant}.violetgov.com/api for VioletGov), with .staging. subdomain variants for staging.

API entry from apis.yml

apis.yml Raw ↑
name: Violet Explore API
description: REST API for programmatic access to your Violet data. The Explore endpoint (POST /api/explore)
  accepts a rich query payload (keyword, filterModel, sort, grouping, pagination) and returns a paginated
  PageDto of entities. Authenticated with an x-api-key header. The API is served per-tenant at https://{tenant}.violetlabs.com/api
  (or {tenant}.violetgov.com/api for VioletGov), with .staging. subdomain variants for staging.
humanURL: https://docs.violetlabs.com/features/api
baseURL: https://app.violetlabs.com/api
properties:
- type: Documentation
  url: https://docs.violetlabs.com/features/api
- type: APIReference
  url: https://docs.violetlabs.com/features/api/endpoints
- type: GettingStarted
  url: https://docs.violetlabs.com/features/api/generate-an-api-key
- type: Authentication
  url: authentication/violetlabs-authentication.yml