Endpoints

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

Note: If you wish to access an API endpoint to your Violet Staging sandbox environment, use the https://[YOUR-TENANT-NAME].staging.violetlabs.com/api/ or https://[YOUR-TENANT-NAME].staging.violetgov.com/api/ endpoints.

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

Explore

Use the Explore endpoint to programmatically access your Violet data.

Generate a query

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.

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

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:

Create a new Postman request, select the POST method, and populate your URL (eg. https://magictoaster.violetlabs.com/api/explore/)
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.

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

Your results should appear below.

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

Why POST?

The Explore and 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.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

post

/api/explore

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-05-10T05:14:13.031Z",
      "updatedAt": "2026-05-10T05:14:13.031Z",
      "externalLastModifiedAt": "2026-05-10T05:14:13.031Z",
      "externalCreatedAt": "2026-05-10T05:14:13.031Z",
      "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"
  }
}

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

columnstringRequired

Query parameters

sizenumberRequired

Responses

200Success

application/json

string[]Optional

get

/api/explore/column/{column}

GET /api/explore/column/{column}?size=1 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  "text"
]

Entities

The entities endpoint returns a broad set of properties and metadata related to an entity or entities. You can use the explore endpoint to determine the entity IDs, and then the entities endpoint to query a deeper set of metadata about the entity.

post

Returns VioletEntityDto (default) or VioletEntityMcpCompactDto when responseScope is mcp_compact, for each id the caller can read. Omit unknown or forbidden ids.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idsstring · uuid[]Required

Violet entity UUIDs to load (e.g. from getEntityRelationships graph nodes). Up to 100 IDs per request.

responseScopestring · enumOptional

Set to mcp_compact for a slim payload suitable for MCP / LLM (omits integrationEntities, schemas, tags, etc.). Omit for the standard VioletEntityDto[] response.

Possible values:

Responses

200

Entities found (subset of requested ids if some are inaccessible). Homogeneous array: full VioletEntityDto when responseScope is omitted, or VioletEntityMcpCompactDto when responseScope is mcp_compact.

application/json

post

/api/entities/by-ids

POST /api/entities/by-ids HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "responseScope": "mcp_compact"
}

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "integrationEntities": [
      {
        "customConfigurationOptions": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "requestConfig": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "integration": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "connection": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "credentials": {},
            "createdAt": "2026-05-10T05:14:13.031Z",
            "updatedAt": "2026-05-10T05:14:13.031Z",
            "application": {
              "id": "text",
              "name": "text",
              "imageUrl": "text",
              "categories": [
                "text"
              ],
              "description": "text",
              "shortDescription": "text",
              "available": true,
              "isHidden": true,
              "apiType": "REST",
              "importFormats": [
                "csv"
              ],
              "defaultImportSchemaConfig": {},
              "externalEntitySchemas": [
                {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "name": "text",
                  "label": "text",
                  "violetCoreEntity": "Account",
                  "connectedEntities": [
                    "text"
                  ],
                  "isReference": true,
                  "isSubEntity": true,
                  "isContainer": true,
                  "propertySchemas": [
                    {
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "programId": "123e4567-e89b-12d3-a456-426614174000",
                      "name": "text",
                      "label": "text",
                      "propertyValue": "text",
                      "violetType": "text",
                      "propertyType": "array",
                      "violetCoreProperty": "Account",
                      "category": "accountNumber",
                      "unit": "text",
                      "isHidden": true,
                      "isRequired": true,
                      "isEditable": true,
                      "namedEntityProperty": "text",
                      "namedEntityType": "text",
                      "hideEmpty": true,
                      "filterEmpty": true,
                      "sysmlType": "text",
                      "enumMap": {},
                      "relationshipType": "containsPOLine",
                      "targetEntity": "text",
                      "parentPropertySchemaId": "text"
                    }
                  ],
                  "updatedAt": "2026-05-10T05:14:13.031Z",
                  "individualEntityFetchRequests": [
                    {}
                  ],
                  "sortedPropertySchemas": [
                    {
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "programId": "123e4567-e89b-12d3-a456-426614174000",
                      "name": "text",
                      "label": "text",
                      "propertyValue": "text",
                      "violetType": "text",
                      "propertyType": "array",
                      "violetCoreProperty": "Account",
                      "category": "accountNumber",
                      "unit": "text",
                      "isHidden": true,
                      "isRequired": true,
                      "isEditable": true,
                      "namedEntityProperty": "text",
                      "namedEntityType": "text",
                      "hideEmpty": true,
                      "filterEmpty": true,
                      "sysmlType": "text",
                      "enumMap": {},
                      "relationshipType": "containsPOLine",
                      "targetEntity": "text",
                      "parentPropertySchemaId": "text"
                    }
                  ],
                  "relatedExternalActions": [
                    {}
                  ],
                  "modelComponentSchemaTransformationSchema": {}
                }
              ],
              "securitySchemes": {},
              "oAuthConfiguration": {},
              "appServerUrl": "text",
              "serverUrlPlaceholder": "text",
              "webUrl": "text",
              "loginRequest": {},
              "testRequest": {},
              "isUserCreated": true,
              "defaultRefreshIntervals": {},
              "partialFetch": true
            },
            "instanceName": "text",
            "numIntegrations": 1,
            "server": "text",
            "user": {},
            "webUrl": "text",
            "downloadUrl": "text",
            "securityScheme": {},
            "hasCustomPermissions": true,
            "isPrivate": true,
            "reauthenticationRequired": true,
            "roles": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission": {
                  "name": "admin",
                  "operations": [
                    "create"
                  ]
                },
                "userIds": [
                  "123e4567-e89b-12d3-a456-426614174000"
                ],
                "groupIds": [
                  "123e4567-e89b-12d3-a456-426614174000"
                ]
              }
            ],
            "userPermissions": {},
            "apiKeyCounter": 1,
            "apiKeyExpiration": "2026-05-10T05:14:13.031Z",
            "useSocks5": true,
            "environment": "text",
            "deploymentEnvironment": "text",
            "description": "text",
            "modifiedBy": "text",
            "configModifiedAt": "2026-05-10T05:14:13.031Z",
            "isValid": true,
            "allowExport": true,
            "isGeneric": true,
            "freeText": "text"
          },
          "restApiConnection": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "credentials": {},
            "createdAt": "2026-05-10T05:14:13.031Z",
            "updatedAt": "2026-05-10T05:14:13.031Z",
            "application": {
              "id": "text",
              "name": "text",
              "imageUrl": "text",
              "categories": [
                "text"
              ],
              "description": "text",
              "shortDescription": "text",
              "available": true,
              "isHidden": true,
              "apiType": "REST",
              "importFormats": [
                "csv"
              ],
              "defaultImportSchemaConfig": {},
              "externalEntitySchemas": [
                {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "name": "text",
                  "label": "text",
                  "violetCoreEntity": "Account",
                  "connectedEntities": [
                    "text"
                  ],
                  "isReference": true,
                  "isSubEntity": true,
                  "isContainer": true,
                  "propertySchemas": [
                    {
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "programId": "123e4567-e89b-12d3-a456-426614174000",
                      "name": "text",
                      "label": "text",
                      "propertyValue": "text",
                      "violetType": "text",
                      "propertyType": "array",
                      "violetCoreProperty": "Account",
                      "category": "accountNumber",
                      "unit": "text",
                      "isHidden": true,
                      "isRequired": true,
                      "isEditable": true,
                      "namedEntityProperty": "text",
                      "namedEntityType": "text",
                      "hideEmpty": true,
                      "filterEmpty": true,
                      "sysmlType": "text",
                      "enumMap": {},
                      "relationshipType": "containsPOLine",
                      "targetEntity": "text",
                      "parentPropertySchemaId": "text"
                    }
                  ],
                  "updatedAt": "2026-05-10T05:14:13.031Z",
                  "individualEntityFetchRequests": [
                    {}
                  ],
                  "sortedPropertySchemas": [
                    {
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "programId": "123e4567-e89b-12d3-a456-426614174000",
                      "name": "text",
                      "label": "text",
                      "propertyValue": "text",
                      "violetType": "text",
                      "propertyType": "array",
                      "violetCoreProperty": "Account",
                      "category": "accountNumber",
                      "unit": "text",
                      "isHidden": true,
                      "isRequired": true,
                      "isEditable": true,
                      "namedEntityProperty": "text",
                      "namedEntityType": "text",
                      "hideEmpty": true,
                      "filterEmpty": true,
                      "sysmlType": "text",
                      "enumMap": {},
                      "relationshipType": "containsPOLine",
                      "targetEntity": "text",
                      "parentPropertySchemaId": "text"
                    }
                  ],
                  "relatedExternalActions": [
                    {}
                  ],
                  "modelComponentSchemaTransformationSchema": {}
                }
              ],
              "securitySchemes": {},
              "oAuthConfiguration": {},
              "appServerUrl": "text",
              "serverUrlPlaceholder": "text",
              "webUrl": "text",
              "loginRequest": {},
              "testRequest": {},
              "isUserCreated": true,
              "defaultRefreshIntervals": {},
              "partialFetch": true
            },
            "instanceName": "text",
            "numIntegrations": 1,
            "server": "text",
            "user": {},
            "webUrl": "text",
            "downloadUrl": "text",
            "securityScheme": {},
            "hasCustomPermissions": true,
            "isPrivate": true,
            "reauthenticationRequired": true,
            "roles": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission": {
                  "name": "admin",
                  "operations": [
                    "create"
                  ]
                },
                "userIds": [
                  "123e4567-e89b-12d3-a456-426614174000"
                ],
                "groupIds": [
                  "123e4567-e89b-12d3-a456-426614174000"
                ]
              }
            ],
            "userPermissions": {},
            "apiKeyCounter": 1,
            "apiKeyExpiration": "2026-05-10T05:14:13.031Z",
            "useSocks5": true,
            "environment": "text",
            "deploymentEnvironment": "text",
            "description": "text",
            "modifiedBy": "text",
            "configModifiedAt": "2026-05-10T05:14:13.031Z",
            "isValid": true,
            "allowExport": true,
            "isGeneric": true,
            "freeText": "text"
          },
          "application": {
            "id": "text",
            "name": "text",
            "imageUrl": "text",
            "categories": [
              "text"
            ],
            "description": "text",
            "shortDescription": "text",
            "available": true,
            "isHidden": true,
            "apiType": "REST",
            "importFormats": [
              "csv"
            ],
            "defaultImportSchemaConfig": {},
            "externalEntitySchemas": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text",
                "label": "text",
                "violetCoreEntity": "Account",
                "connectedEntities": [
                  "text"
                ],
                "isReference": true,
                "isSubEntity": true,
                "isContainer": true,
                "propertySchemas": [
                  {
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "programId": "123e4567-e89b-12d3-a456-426614174000",
                    "name": "text",
                    "label": "text",
                    "propertyValue": "text",
                    "violetType": "text",
                    "propertyType": "array",
                    "violetCoreProperty": "Account",
                    "category": "accountNumber",
                    "unit": "text",
                    "isHidden": true,
                    "isRequired": true,
                    "isEditable": true,
                    "namedEntityProperty": "text",
                    "namedEntityType": "text",
                    "hideEmpty": true,
                    "filterEmpty": true,
                    "sysmlType": "text",
                    "enumMap": {},
                    "relationshipType": "containsPOLine",
                    "targetEntity": "text",
                    "parentPropertySchemaId": "text"
                  }
                ],
                "updatedAt": "2026-05-10T05:14:13.031Z",
                "individualEntityFetchRequests": [
                  {}
                ],
                "sortedPropertySchemas": [
                  {
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "programId": "123e4567-e89b-12d3-a456-426614174000",
                    "name": "text",
                    "label": "text",
                    "propertyValue": "text",
                    "violetType": "text",
                    "propertyType": "array",
                    "violetCoreProperty": "Account",
                    "category": "accountNumber",
                    "unit": "text",
                    "isHidden": true,
                    "isRequired": true,
                    "isEditable": true,
                    "namedEntityProperty": "text",
                    "namedEntityType": "text",
                    "hideEmpty": true,
                    "filterEmpty": true,
                    "sysmlType": "text",
                    "enumMap": {},
                    "relationshipType": "containsPOLine",
                    "targetEntity": "text",
                    "parentPropertySchemaId": "text"
                  }
                ],
                "relatedExternalActions": [
                  {}
                ],
                "modelComponentSchemaTransformationSchema": {}
              }
            ],
            "securitySchemes": {},
            "oAuthConfiguration": {},
            "appServerUrl": "text",
            "serverUrlPlaceholder": "text",
            "webUrl": "text",
            "loginRequest": {},
            "testRequest": {},
            "isUserCreated": true,
            "defaultRefreshIntervals": {},
            "partialFetch": true
          },
          "applicationId": "123e4567-e89b-12d3-a456-426614174000",
          "numIntegrationEntities": 1,
          "createdAt": "2026-05-10T05:14:13.031Z",
          "lastFetchedAt": "2026-05-10T05:14:13.031Z",
          "updatedAt": "2026-05-10T05:14:13.031Z",
          "config": {},
          "integrationEntities": "[Circular Reference]",
          "user": "[Circular Reference]",
          "fetchStatus": "queued",
          "lastFetchInfo": "text",
          "lastFetchFetchType": "full_initial",
          "isPaused": true,
          "isPrivate": true,
          "canEdit": true,
          "canDelete": true,
          "importId": "123e4567-e89b-12d3-a456-426614174000",
          "autoPushToIntegrationIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "onlyPushReleasedEntities": true,
          "onlyPushPartsInReleasedAssemblies": true,
          "onlyPushCompleteAssemblies": true,
          "releaseBomsOnPush": true,
          "pushAttachments": true,
          "removeRelationshipsThatNoLongerExistInPushToIntegrations": true,
          "doNotPushAssemblyRelationships": true,
          "nextFetch": "2026-05-10T05:14:13.031Z",
          "selectedContainerExternalIds": [
            "text"
          ],
          "roles": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission": {
                "name": "admin",
                "operations": [
                  "create"
                ]
              },
              "userIds": [
                "123e4567-e89b-12d3-a456-426614174000"
              ],
              "groupIds": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            }
          ],
          "userPermissions": {},
          "programId": "text",
          "hasCustomPermissions": true,
          "parentId": "text",
          "autoPushToIntegrationNames": [
            "text"
          ],
          "autoPushToApplicationIdsIntegrationNames": {},
          "userInputPathsToExcludeOnUpdateEntityPushes": [
            "text"
          ],
          "currentJobId": "text",
          "modifiedBy": "text",
          "configModifiedAt": "2026-05-10T05:14:13.031Z"
        },
        "violetRelationshipSpecs": [
          "[Circular Reference]"
        ],
        "entityName": "text",
        "createdAt": "2026-05-10T05:14:13.031Z",
        "updatedAt": "2026-05-10T05:14:13.031Z",
        "transformationSchemas": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "targetApplicationId": "123e4567-e89b-12d3-a456-426614174000",
            "targetApplicationName": "text",
            "targetIntegrationEntityIds": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          }
        ],
        "externalEntitySchema": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "label": "text",
          "violetCoreEntity": "Account",
          "connectedEntities": [
            "text"
          ],
          "isReference": true,
          "isSubEntity": true,
          "isContainer": true,
          "propertySchemas": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "programId": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "label": "text",
              "propertyValue": "text",
              "violetType": "text",
              "propertyType": "array",
              "violetCoreProperty": "Account",
              "category": "accountNumber",
              "unit": "text",
              "isHidden": true,
              "isRequired": true,
              "isEditable": true,
              "namedEntityProperty": "text",
              "namedEntityType": "text",
              "hideEmpty": true,
              "filterEmpty": true,
              "sysmlType": "text",
              "enumMap": {},
              "relationshipType": "containsPOLine",
              "targetEntity": "text",
              "parentPropertySchemaId": "text"
            }
          ],
          "updatedAt": "2026-05-10T05:14:13.031Z",
          "individualEntityFetchRequests": [
            {}
          ],
          "sortedPropertySchemas": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "programId": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "label": "text",
              "propertyValue": "text",
              "violetType": "text",
              "propertyType": "array",
              "violetCoreProperty": "Account",
              "category": "accountNumber",
              "unit": "text",
              "isHidden": true,
              "isRequired": true,
              "isEditable": true,
              "namedEntityProperty": "text",
              "namedEntityType": "text",
              "hideEmpty": true,
              "filterEmpty": true,
              "sysmlType": "text",
              "enumMap": {},
              "relationshipType": "containsPOLine",
              "targetEntity": "text",
              "parentPropertySchemaId": "text"
            }
          ],
          "relatedExternalActions": [
            {}
          ],
          "modelComponentSchemaTransformationSchema": {}
        },
        "externalEntitySchemaId": "123e4567-e89b-12d3-a456-426614174000",
        "pushFilters": [
          {}
        ],
        "excludeFromPushingToIntegrationIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "nextFetchTypeOverride": "full_initial"
      }
    ],
    "properties": {},
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "color": "text",
        "taggingsCount": 1,
        "taggedEntityIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "applicationId": "123e4567-e89b-12d3-a456-426614174000",
    "application": {
      "id": "text",
      "name": "text",
      "imageUrl": "text",
      "categories": [
        "text"
      ],
      "description": "text",
      "shortDescription": "text",
      "available": true,
      "isHidden": true,
      "apiType": "REST",
      "importFormats": [
        "csv"
      ],
      "defaultImportSchemaConfig": {},
      "externalEntitySchemas": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "label": "text",
          "violetCoreEntity": "Account",
          "connectedEntities": [
            "text"
          ],
          "isReference": true,
          "isSubEntity": true,
          "isContainer": true,
          "propertySchemas": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "programId": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "label": "text",
              "propertyValue": "text",
              "violetType": "text",
              "propertyType": "array",
              "violetCoreProperty": "Account",
              "category": "accountNumber",
              "unit": "text",
              "isHidden": true,
              "isRequired": true,
              "isEditable": true,
              "namedEntityProperty": "text",
              "namedEntityType": "text",
              "hideEmpty": true,
              "filterEmpty": true,
              "sysmlType": "text",
              "enumMap": {},
              "relationshipType": "containsPOLine",
              "targetEntity": "text",
              "parentPropertySchemaId": "text"
            }
          ],
          "updatedAt": "2026-05-10T05:14:13.031Z",
          "individualEntityFetchRequests": [
            {}
          ],
          "sortedPropertySchemas": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "programId": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "label": "text",
              "propertyValue": "text",
              "violetType": "text",
              "propertyType": "array",
              "violetCoreProperty": "Account",
              "category": "accountNumber",
              "unit": "text",
              "isHidden": true,
              "isRequired": true,
              "isEditable": true,
              "namedEntityProperty": "text",
              "namedEntityType": "text",
              "hideEmpty": true,
              "filterEmpty": true,
              "sysmlType": "text",
              "enumMap": {},
              "relationshipType": "containsPOLine",
              "targetEntity": "text",
              "parentPropertySchemaId": "text"
            }
          ],
          "relatedExternalActions": [
            {}
          ],
          "modelComponentSchemaTransformationSchema": {}
        }
      ],
      "securitySchemes": {},
      "oAuthConfiguration": {},
      "appServerUrl": "text",
      "serverUrlPlaceholder": "text",
      "webUrl": "text",
      "loginRequest": {},
      "testRequest": {},
      "isUserCreated": true,
      "defaultRefreshIntervals": {},
      "partialFetch": true
    },
    "folder": {
      "id": "text",
      "name": "text",
      "description": "text",
      "order": 1,
      "orderLabel": "text",
      "parentId": "text",
      "parent": {
        "id": "text",
        "name": "text",
        "description": "text",
        "order": 1,
        "orderLabel": "text",
        "parentId": "text",
        "parent": {
          "id": "text",
          "name": "text",
          "description": "text",
          "order": 1,
          "orderLabel": "text",
          "parentId": "text",
          "parent": "[Circular Reference]",
          "children": "[Circular Reference]",
          "violetId": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text"
          },
          "style": {},
          "createdBy": "[Circular Reference]",
          "createdAt": "2026-05-10T05:14:13.031Z",
          "updatedAt": "2026-05-10T05:14:13.031Z",
          "allParentData": [
            {}
          ]
        },
        "children": [
          "[Circular Reference]"
        ],
        "violetId": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "style": {},
        "createdBy": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "email": "[email protected]",
          "fullname": "text",
          "firstName": "text",
          "lastName": "text",
          "avatarUrl": "text",
          "type": "system",
          "isVerified": true,
          "tenantUsers": "[Circular Reference]",
          "alternateEmailAddress": "[email protected]",
          "otp": {
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "jwt": "text"
          },
          "loginMethods": [
            {}
          ],
          "oidcUpdatedFields": {},
          "magicLinkCode": "123e4567-e89b-12d3-a456-426614174000",
          "lastLoginTimestamp": "2026-05-10T05:14:13.031Z",
          "totalLoginCount": 1
        },
        "createdAt": "2026-05-10T05:14:13.031Z",
        "updatedAt": "2026-05-10T05:14:13.031Z",
        "allParentData": [
          {}
        ]
      },
      "children": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "order": 1,
          "orderLabel": "text",
          "parentId": "text",
          "parent": {
            "id": "text",
            "name": "text",
            "description": "text",
            "order": 1,
            "orderLabel": "text",
            "parentId": "text",
            "parent": {
              "id": "text",
              "name": "text",
              "description": "text",
              "order": 1,
              "orderLabel": "text",
              "parentId": "text",
              "parent": "[Circular Reference]",
              "children": "[Circular Reference]",
              "violetId": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text"
              },
              "style": {},
              "createdBy": "[Circular Reference]",
              "createdAt": "2026-05-10T05:14:13.031Z",
              "updatedAt": "2026-05-10T05:14:13.031Z",
              "allParentData": [
                {}
              ]
            },
            "children": [
              "[Circular Reference]"
            ],
            "violetId": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text"
            },
            "style": {},
            "createdBy": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "email": "[email protected]",
              "fullname": "text",
              "firstName": "text",
              "lastName": "text",
              "avatarUrl": "text",
              "type": "system",
              "isVerified": true,
              "tenantUsers": "[Circular Reference]",
              "alternateEmailAddress": "[email protected]",
              "otp": {
                "userId": "123e4567-e89b-12d3-a456-426614174000",
                "jwt": "text"
              },
              "loginMethods": [
                {}
              ],
              "oidcUpdatedFields": {},
              "magicLinkCode": "123e4567-e89b-12d3-a456-426614174000",
              "lastLoginTimestamp": "2026-05-10T05:14:13.031Z",
              "totalLoginCount": 1
            },
            "createdAt": "2026-05-10T05:14:13.031Z",
            "updatedAt": "2026-05-10T05:14:13.031Z",
            "allParentData": [
              {}
            ]
          },
          "children": "[Circular Reference]",
          "violetId": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text"
          },
          "style": {},
          "createdBy": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "email": "[email protected]",
            "fullname": "text",
            "firstName": "text",
            "lastName": "text",
            "avatarUrl": "text",
            "type": "system",
            "isVerified": true,
            "tenantUsers": "[Circular Reference]",
            "alternateEmailAddress": "[email protected]",
            "otp": {
              "userId": "123e4567-e89b-12d3-a456-426614174000",
              "jwt": "text"
            },
            "loginMethods": [
              {}
            ],
            "oidcUpdatedFields": {},
            "magicLinkCode": "123e4567-e89b-12d3-a456-426614174000",
            "lastLoginTimestamp": "2026-05-10T05:14:13.031Z",
            "totalLoginCount": 1
          },
          "createdAt": "2026-05-10T05:14:13.031Z",
          "updatedAt": "2026-05-10T05:14:13.031Z",
          "allParentData": [
            {}
          ]
        }
      ],
      "violetId": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "style": {},
      "createdBy": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[email protected]",
        "fullname": "text",
        "firstName": "text",
        "lastName": "text",
        "avatarUrl": "text",
        "type": "system",
        "isVerified": true,
        "tenantUsers": "[Circular Reference]",
        "alternateEmailAddress": "[email protected]",
        "otp": {
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "jwt": "text"
        },
        "loginMethods": [
          {}
        ],
        "oidcUpdatedFields": {},
        "magicLinkCode": "123e4567-e89b-12d3-a456-426614174000",
        "lastLoginTimestamp": "2026-05-10T05:14:13.031Z",
        "totalLoginCount": 1
      },
      "createdAt": "2026-05-10T05:14:13.031Z",
      "updatedAt": "2026-05-10T05:14:13.031Z",
      "allParentData": [
        {}
      ]
    },
    "key": "text",
    "externalId": "text",
    "externalUrl": "text",
    "downloadUrl": "text",
    "s3FileUrl": "text",
    "thumbnailDownloadUrl": "text",
    "thumbnailS3FileUrl": "text",
    "applicationIcon": "text",
    "rawJsonPayload": {},
    "rawJsonPayloadHash": "text",
    "isNew": true,
    "isReference": true,
    "isSubEntity": true,
    "isRevision": true,
    "isContainer": true,
    "createdAt": "2026-05-10T05:14:13.031Z",
    "updatedAt": "2026-05-10T05:14:13.031Z",
    "deletedAt": "2026-05-10T05:14:13.031Z",
    "tenantId": "123e4567-e89b-12d3-a456-426614174000",
    "violetId": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "schema": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "label": "text",
      "violetCoreEntity": "Account",
      "connectedEntities": [
        "text"
      ],
      "isReference": true,
      "isSubEntity": true,
      "isContainer": true,
      "propertySchemas": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "programId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "label": "text",
          "propertyValue": "text",
          "violetType": "text",
          "propertyType": "array",
          "violetCoreProperty": "Account",
          "category": "accountNumber",
          "unit": "text",
          "isHidden": true,
          "isRequired": true,
          "isEditable": true,
          "namedEntityProperty": "text",
          "namedEntityType": "text",
          "hideEmpty": true,
          "filterEmpty": true,
          "sysmlType": "text",
          "enumMap": {},
          "relationshipType": "containsPOLine",
          "targetEntity": "text",
          "parentPropertySchemaId": "text"
        }
      ],
      "updatedAt": "2026-05-10T05:14:13.031Z",
      "individualEntityFetchRequests": [
        {}
      ],
      "sortedPropertySchemas": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "programId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "label": "text",
          "propertyValue": "text",
          "violetType": "text",
          "propertyType": "array",
          "violetCoreProperty": "Account",
          "category": "accountNumber",
          "unit": "text",
          "isHidden": true,
          "isRequired": true,
          "isEditable": true,
          "namedEntityProperty": "text",
          "namedEntityType": "text",
          "hideEmpty": true,
          "filterEmpty": true,
          "sysmlType": "text",
          "enumMap": {},
          "relationshipType": "containsPOLine",
          "targetEntity": "text",
          "parentPropertySchemaId": "text"
        }
      ],
      "relatedExternalActions": [
        {}
      ],
      "modelComponentSchemaTransformationSchema": {}
    },
    "schemaId": "123e4567-e89b-12d3-a456-426614174000",
    "parameterId": "123e4567-e89b-12d3-a456-426614174000",
    "containerIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "programIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "externalLastModifiedAt": "2026-05-10T05:14:13.031Z",
    "externalCreatedAt": "2026-05-10T05:14:13.031Z",
    "violetCorePropertyValues": {},
    "violetCoreEntity": "Account",
    "namedEntityProperties": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "namedEntityId": "123e4567-e89b-12d3-a456-426614174000",
        "violetEntityId": "123e4567-e89b-12d3-a456-426614174000",
        "propertyName": "text",
        "propertyIndex": 1,
        "namedEntity": {
          "type": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "violetEntityProperties": "[Circular Reference]"
        }
      }
    ],
    "lastAttemptedJob": "text",
    "connectionIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "integrationIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "integrationNames": [
      "text"
    ],
    "violetScriptId": "123e4567-e89b-12d3-a456-426614174000",
    "outputs": {},
    "scriptContent": {},
    "scriptVariables": {},
    "scriptLanguage": "Python",
    "internalEntitySchema": {
      "id": "text",
      "createdAt": "2026-05-10T05:14:13.031Z",
      "updatedAt": "2026-05-10T05:14:13.031Z",
      "deletedAt": "2026-05-10T05:14:13.031Z",
      "name": "text",
      "label": "text",
      "propertySchemas": [
        {
          "id": "text",
          "createdAt": "2026-05-10T05:14:13.031Z",
          "updatedAt": "2026-05-10T05:14:13.031Z",
          "deletedAt": "2026-05-10T05:14:13.031Z",
          "name": "text",
          "targetName": "text",
          "label": "text",
          "propertyValue": "text",
          "defaultPropertyValue": "text",
          "fallbackPropertyValue": "text",
          "propertyRequestValue": "text",
          "propertyTransformers": [
            "CALCULATE_RELEASE_DATE_FROM_SOLIDWORKS_PDM"
          ],
          "isEditable": true,
          "isRequired": true,
          "templatedPropertyUpdateRequestSpec": {},
          "enumMap": {},
          "enumName": "text",
          "violetType": {},
          "propertyType": "array",
          "violetCoreProperty": "Account",
          "category": "accountNumber",
          "unit": "text",
          "targetEntity": "text",
          "targetPropertyValue": "text",
          "order": 1,
          "isHidden": true,
          "hidePropertyActivities": true,
          "namedEntityType": {},
          "namedEntityProperty": {},
          "entitySchemas": "[Circular Reference]",
          "parentPropertySchemaId": "text",
          "parentPropertySchema": "[Circular Reference]",
          "childPropertySchemas": "[Circular Reference]",
          "hideEmpty": true,
          "filterEmpty": true,
          "targetEntityLookupField": "text",
          "sysmlType": "text",
          "program": "[Circular Reference]",
          "programId": "text",
          "sharedPrograms": "[Circular Reference]",
          "relationshipType": "containsPOLine"
        }
      ],
      "violetCoreEntity": "Account",
      "disableDelete": true,
      "key": {},
      "externalIdPrefix": "text",
      "externalId": {},
      "externalDescription": {},
      "externalName": {},
      "fallbackExternalName": {},
      "externalLastModifiedAt": {},
      "externalCreatedAt": {},
      "alternateIds": [
        {}
      ],
      "externalUrl": {},
      "downloadUrls": [
        "text"
      ],
      "thumbnailDownloadUrls": [
        {}
      ],
      "isReference": true,
      "isSubEntity": true,
      "hasRevisions": true,
      "isRevision": true,
      "isContainer": true,
      "applicationId": "text",
      "revisionParentId": {},
      "s3FileUrl": "text",
      "thumbnailS3FileUrl": "text",
      "hashExcludeKeys": [
        "text"
      ],
      "parameters": [
        {
          "id": "text",
          "createdAt": "2026-05-10T05:14:13.031Z",
          "updatedAt": "2026-05-10T05:14:13.031Z",
          "deletedAt": "2026-05-10T05:14:13.031Z",
          "name": "text",
          "isTemplate": true,
          "templateId": "text",
          "internalEntitySchema": "[Circular Reference]",
          "internalEntitySchemaId": "text",
          "violetEntities": "[Circular Reference]"
        }
      ],
      "violetEntities": [
        {
          "id": "text",
          "createdAt": "2026-05-10T05:14:13.031Z",
          "updatedAt": "2026-05-10T05:14:13.031Z",
          "deletedAt": "2026-05-10T05:14:13.031Z",
          "integrationEntities": "[Circular Reference]",
          "parameterId": "text",
          "applicationId": "text",
          "application": "[Circular Reference]",
          "parameter": "[Circular Reference]",
          "name": "text",
          "description": "text",
          "rawJsonPayload": {},
          "properties": {},
          "coreProperties": {},
          "externalId": "text",
          "key": "text",
          "externalUrl": "text",
          "downloadUrl": "text",
          "s3FileUrl": "text",
          "thumbnailDownloadUrl": "text",
          "thumbnailS3FileUrl": "text",
          "fallbackExternalName": "text",
          "alternateIds": [
            "text"
          ],
          "rawJsonPayloadHash": "text",
          "activities": "[Circular Reference]",
          "notificationSubscriptions": "[Circular Reference]",
          "scriptSubscriptions": "[Circular Reference]",
          "isNew": true,
          "stubType": "CREATE",
          "isReference": true,
          "isSubEntity": true,
          "isContainer": true,
          "hasRevisions": true,
          "isRevision": true,
          "revisionParentId": "text",
          "externalLastModifiedAt": "2026-05-10T05:14:13.031Z",
          "externalCreatedAt": "2026-05-10T05:14:13.031Z",
          "pushPendingStatus": "create",
          "pushStatus": "queued",
          "lastPushedAt": "2026-05-10T05:14:13.031Z",
          "lastPushInfo": "text",
          "lastPushJobId": "text",
          "autoPushTargetIntegrationEntities": "[Circular Reference]",
          "taggings": "[Circular Reference]",
          "violetId": "[Circular Reference]",
          "idOfVioletId": "text",
          "folder": "[Circular Reference]",
          "namedEntityVioletEntityProperties": "[Circular Reference]",
          "violetScriptId": "text",
          "violetScript": "[Circular Reference]",
          "outputs": {},
          "scriptContent": {},
          "scriptVariables": {},
          "scriptLanguage": "Python",
          "internalEntitySchemaId": "text",
          "internalEntitySchema": "[Circular Reference]",
          "workflows": "[Circular Reference]",
          "workflowTemplates": "[Circular Reference]",
          "violetEntityFetchResults": "[Circular Reference]",
          "fetchStatus": "queued",
          "lastFetchedAt": "2026-05-10T05:14:13.031Z",
          "lastFetchInfo": "text",
          "entitySubscriptions": "[Circular Reference]",
          "sourceEntitySubscriptions": "[Circular Reference]",
          "entityDesignations": [
            "ASSEMBLY"
          ],
          "requirements": "[Circular Reference]",
          "evidenceVerifications": "[Circular Reference]",
          "unifyingVioletId": "[Circular Reference]",
          "idOfUnifyingVioletId": "text",
          "createdIntegration": "[Circular Reference]",
          "integrationEvents": "[Circular Reference]",
          "isLatestRevision": true,
          "state": "[Circular Reference]",
          "files": "[Circular Reference]",
          "comments": "[Circular Reference]",
          "createdBy": "[Circular Reference]",
          "createdById": "text",
          "requirementId": "text",
          "requirement": "[Circular Reference]",
          "verificationId": "text",
          "verification": "[Circular Reference]",
          "verificationMethods": "[Circular Reference]",
          "statusId": "text",
          "status": "[Circular Reference]",
          "peerReviewRequirements": "[Circular Reference]"
        }
      ]
    },
    "import": true,
    "pushStatus": "queued",
    "lastPushedAt": "2026-05-10T05:14:13.031Z",
    "lastPushInfo": "text",
    "lastSuccessfulJob": "123e4567-e89b-12d3-a456-426614174000",
    "canEdit": true,
    "entityDesignations": [
      "ASSEMBLY"
    ],
    "isCustomEntity": true
  }
]

get

Get a Violet Entity

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

idstring · uuidRequired

namestringRequired

descriptionstringOptional

propertiesobjectRequired

applicationIdstring · uuidOptional

keystringRequired

externalIdstringRequired

externalUrlstringRequired

downloadUrlstringRequired

s3FileUrlstringRequired

thumbnailDownloadUrlstringRequired

thumbnailS3FileUrlstringRequired

applicationIconstringRequired

rawJsonPayloadobjectOptional

rawJsonPayloadHashstringOptional

isNewbooleanOptional

isReferencebooleanRequired

isSubEntitybooleanRequired

isRevisionbooleanRequired

isContainerbooleanOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

deletedAtstring · date-timeOptional

tenantIdstring · uuidOptional

schemaIdstring · uuidOptional

parameterIdstring · uuidOptional

containerIdsstring · uuid[]Optional

programIdsstring · uuid[]Optional

externalLastModifiedAtstring · date-timeOptional

externalCreatedAtstring · date-timeOptional

violetCorePropertyValuesobjectOptional

violetCoreEntitystring · enumOptionalPossible values:

lastAttemptedJobstringOptional

connectionIdsstring · uuid[]Optional

integrationIdsstring · uuid[]Optional

integrationNamesstring[]Optional

violetScriptIdstring · uuidOptional

outputsobjectOptional

scriptContentobjectOptional

scriptVariablesobjectOptional

scriptLanguagestring · enumOptionalPossible values:

importbooleanRequired

pushStatusstring · enumOptionalPossible values:

lastPushedAtstring · date-timeOptional

lastPushInfostringOptional

lastSuccessfulJobstring · uuidOptional

canEditbooleanOptional

isCustomEntitybooleanOptional

get

/api/entities/{id}

GET /api/entities/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Returned if the request is successful.

application/json

thumbnailUrlstringRequired

Pre-signed URL for downloading the thumbnail image

get

/api/entities/{id}/thumbnail-url

200

Returned if the request is successful.

Relationships

Use the violet-relationships endpoint to query relationships between entities. We recommend using the explore endpoint to identify the sourceID for the entity or entities you're interested in, then the violet-relationships endpoint to to build out structures like PO Lines belonging to a Purchase Order, or Parts belonging to an Assembly.

get

Get all Violet Relationships, or relationship graph from a source entity. When sourceId is provided, returns a graph (entityNodes, requirementNodes, links) for traversal: Assembly → BOM → Parts, Part/BOM line → PO line → PO, PO ↔ Invoice ↔ Bill, PO/line → receipts/delivery. Use recursiveRelationshipTypes / nonRecursiveRelationshipTypes to restrict traversal; see GET /model for types.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sourceIdstring · uuidOptional

Violet entity ID to start graph traversal from. If omitted, returns all relationships.

recursiveRelationshipTypesstringOptional

Comma-separated relationship types to follow recursively (e.g. assemblyContains,contains for BOM; containsPOLine,receipts,linkedTo for PO/delivery/3-way match). See GET /model for all types.

Example: assemblyContains,contains

nonRecursiveRelationshipTypesstringOptional

Comma-separated relationship types to include only one level.

Example: contains

afterIdstring · uuidOptional

When sourceId is omitted, cursor for keyset pagination: relationship id from the last item of the previous response. Omit for the first page. Ignored when sourceId is provided.

limitinteger · min: 1 · max: 500Optional

When sourceId is omitted, max readable relationships per page (default 100, max 500). Ignored when sourceId is provided.

Default: 100

Responses

200

Without sourceId: array of relationships (paginated). With sourceId: graph of nodes and links.

application/json

get

/api/violet-relationships

200

Without sourceId: array of relationships (paginated). With sourceId: graph of nodes and links.

Get relationship model (types and examples) for assistant/MCP traversal

get

Relationship model for MCP/assistant: which entity types can be related and in which direction. Returns allRelationshipTypes and relationshipTypeExamples (from current DB specs). Use with GET /violet-relationships?sourceId=... to traverse Assembly–BOM–Part, Part–PO line–PO, PO–Invoice–Bill, etc. Optional suggestPath: comma-separated entity types (e.g. "Part,Purchase Order" or "Purchase Order,Invoice,Bill" for 3-way match); response includes suggestedTypesForPath to pass as recursiveRelationshipTypes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

suggestPathstringOptional

Comma-separated entity types to get suggested relationship types for (e.g. "Part,Purchase Order" or "Purchase Order,Invoice,Bill" for 3-way match). Response includes suggestedTypesForPath to pass as recursiveRelationshipTypes to getEntityRelationships.

Responses

200Success

application/json

get

/api/violet-relationships/model

200Success

Activities

The activities endpoint can be used to query activity and change history across your Violet tenant or for specific entities in your Violet environment.

get

Gets all the activities in Violet System.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returned if the request is successful.

application/json

itemsobject[]Required

hasNextPagebooleanRequired

get

/api/activities

200

Returned if the request is successful.

post

Returns VioletEntityDto (default) or VioletEntityMcpCompactDto when responseScope is mcp_compact, for each id the caller can read. Omit unknown or forbidden ids.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idsstring · uuid[]Required

Violet entity UUIDs to load (e.g. from getEntityRelationships graph nodes). Up to 100 IDs per request.

responseScopestring · enumOptional

Set to mcp_compact for a slim payload suitable for MCP / LLM (omits integrationEntities, schemas, tags, etc.). Omit for the standard VioletEntityDto[] response.

Possible values:

Responses

200

application/json

post

/api/entities/by-ids

200

get

Gets a parentActivity in Violet System.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Activity with specified ID

application/json

idstringRequired

classstring · enumRequiredPossible values:

eventTypestring · enumRequiredPossible values:

detailsobjectRequired

createdAtstring · date-timeRequired

tenantIdstringRequired

parentActivityIdstringOptional

allDescendantIdsstring[]Optional

fetchJobIdstringOptional

isHiddenbooleanRequired

get

/api/activities/{id}

200

Activity with specified ID

get

Gets all the Activities for a Violet Entity in the Violet System

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

externalIdstringRequired

External ID of the Violet Entity

integrationEntityIdsstring[]Required

Integration Entity IDs to filter by

limitintegerOptional

The maximum number of results to return.

pageintegerOptional

A page number within the paginated result set.

Responses

200

Activities pertaining to the given Violet Entity

application/json

get

/api/activities/violet-entity

200

Activities pertaining to the given Violet Entity

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

violetEntityIdstringRequired

Internal ID of the Violet Entity

limitintegerOptional

The maximum number of results to return.

pageintegerOptional

A page number within the paginated result set.

Responses

200

Activities pertaining to the given internal Violet Entity

application/json

get

/api/activities/internal-violet-entity

200

Activities pertaining to the given internal Violet Entity

PreviousGenerate an API key NextDashboards

Last updated 1 day ago

Was this helpful?

hashtagGetting started

hashtagExplore

hashtagGenerate a query

hashtagTry it out in Postman

hashtagWhy POST?

hashtagEntities

hashtagRelationships

hashtagGet relationship model (types and examples) for assistant/MCP traversal

hashtagActivities

Getting started

Explore

Generate a query

Try it out in Postman

Why POST?

Entities

Relationships

Get relationship model (types and examples) for assistant/MCP traversal

Activities