Explore endpoint

Use the Explore endpoint to programmatically access your Violet data.

Getting started

First, you'll need to Generate an API key.

Next, your API endpoint is either:

• https://[YOUR-TENANT-NAME].violetlabs.com/api/ for Violet customers

• https://[YOUR-TENANT-NAME].violetgov.com/api/ for VioletGov customers

Last, the API payload is described in the API specification below, but the easiest way to generate a query is actually via the Data Explorer.

Generate a query

1. Head to Data Explorer to generate a query. You can use Quick Views, a saved exploration, or filters to configure the query for the data you're interested in.

1. Next, click the Copy API payload button in the toolbar.

1. The API payload for the query will copy to your clipboard - you can then paste this directly into a request.

Try it out in Postman

To test in Postman:

1. Create a new Postman request, select the POST method, and populate your URL (eg. https://magictoaster.violetlabs.com/api/explore/)

2. In the Authorization tab, select API Key in the Auth Type dropdown. Enter x-api-key for the Key, and populate your API key for the Value.

1. In the Body tab, select raw, then paste the API payload you generated above. Click Send.

1. Your results should appear below.

1. We love using Postman's Visualizer to generate visualizations of your data:

Why POST?

The Explore endpoint supports a rich set of data filtering options, so Violet uses a POST endpoint for the query. This allows complex queries to be sent in a body payload instead of directly in the URL.

API specification

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

keywordstringOptional

Search keyword to filter entities

Example: part number

groupKeysarrayOptional

Array of group keys (strings or objects)

sortobjectOptional

Elasticsearch sort configuration

pagenumber · min: 1Optional

Page number (1-indexed)

Example: 1

limitnumber · min: 1Optional

Number of items per page

Example: 50

includeParametersbooleanOptional

Whether to include parameters in the response

Default: false

includeSubEntitiesbooleanOptional

Whether to include sub-entities in the response

Default: false

includeSchemasbooleanOptional

Whether to include entity schemas in the response

Default: false

Responses

200

Search for entities

application/json

and

post

/api/explore

HTTPcURLJavaScriptPython

POST /api/explore HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "keyword": "part number",
  "rowGroupCols": [
    {
      "id": "text",
      "displayName": "text",
      "field": "text"
    }
  ],
  "groupKeys": [],
  "filterModel": {
    "ANY_ADDITIONAL_PROPERTY": {
      "filterType": "text",
      "type": "text",
      "operator": "AND",
      "filter": "text",
      "filterTo": "text",
      "dateFrom": "text",
      "dateTo": "text",
      "values": [
        "text"
      ],
      "conditions": []
    }
  },
  "sort": {},
  "page": 1,
  "limit": 50,
  "includeParameters": false,
  "includeSubEntities": false,
  "includeSchemas": false
}

200

Search for entities

{
  "items": [
    {
      "id": "text",
      "entityType": "text",
      "key": "text",
      "name": "text",
      "externalId": "text",
      "tenantId": "text",
      "createdAt": "2026-03-13T14:37:51.371Z",
      "updatedAt": "2026-03-13T14:37:51.371Z",
      "externalLastModifiedAt": "2026-03-13T14:37:51.371Z",
      "externalCreatedAt": "2026-03-13T14:37:51.371Z",
      "violetId": "text",
      "violetCoreEntity": "Account",
      "externalUrl": "text",
      "description": "text",
      "s3FileUrl": "text",
      "isReference": true,
      "isSubEntity": true,
      "isRevision": true,
      "isContainer": true,
      "isCustomEntity": true,
      "namedEntityProperties": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "namedEntityId": "123e4567-e89b-12d3-a456-426614174000",
          "violetEntityId": "123e4567-e89b-12d3-a456-426614174000",
          "propertyName": "text",
          "propertyIndex": 1,
          "namedEntity": "[Circular Reference]"
        }
      ],
      "application": {
        "id": "text",
        "name": "text",
        "imageUrl": "text"
      },
      "applicationId": "text",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "description": "text",
          "color": "text",
          "taggingsCount": 1,
          "taggedEntityIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "connectionIds": [
        "text"
      ],
      "programIds": [
        "text"
      ],
      "integrationIds": [
        "text"
      ],
      "integrationNames": [
        "text"
      ],
      "externalEntitySchemaIds": [
        "text"
      ],
      "internalEntitySchemaIds": [
        "text"
      ],
      "violetScriptId": "text",
      "parameterId": "text",
      "assignee": "text",
      "cost": 1,
      "dueDate": "text",
      "mass": 1,
      "part": "text",
      "status": "text",
      "import": true,
      "properties": {},
      "categories": {},
      "entityDesignations": [
        "ASSEMBLY"
      ],
      "partOrAssemblyDescriptor": "ASSEMBLY"
    }
  ],
  "meta": {
    "itemCount": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "totalPages": 1,
    "currentPage": 1
  },
  "links": {
    "first": "text",
    "previous": "text",
    "next": "text",
    "last": "text"
  }
}