API Reference

List data dictionary entries

get
https://expert.inskill.ai/public/apiv3/datadictionary

Returns all data dictionary entries (custom fields/variables) available to the authenticated API key's account.

Data Dictionary Overview:
Data dictionary entries define custom fields that can be used throughout the platform:

  • Asset Fields (type: 1): Custom fields stored on asset instances (e.g., temperature, serial_number, location)
  • Expertise Fields (type: 0): Fields used in tasks/steps for feedback, dependencies, or looping

Data Types:

  • 0: Boolean
  • 1: Integer
  • 2: Float
  • 3: Enum/List (with predefined key:value options)
  • 4: String
  • 5: Observation (photo-based)

💡 Tip: Use data dictionary entries to define the structure of asset data fields and expertise variables for your products.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Fields allows you to return a subset of the default fields (comma-separated list).

Supported fields:

  • data_type: Data type enum (0=unknown, 1=text, 2=number, 3=enum, 4=string, 5=observation)
  • defaults: Default values for this field
  • guid: Entry GUID
  • id: Entry ID
  • key: Field key/name
  • node_id: Component tree node ID (if the entry is scoped to a specific component)
  • parent_id: Parent entry ID (for nested fields)
  • product_id: Product this entry belongs to
  • supplier_id: Supplier ID (populated if supplied)
  • type: Entry type (0=expertise variable, 1=asset field)
  • values: Allowed values (used with enum data types)
string

Filter Format: filter[field][operator]=value

Invalid filter formats will return a 422 status code with detailed error information.

Supported operators:

  • eq: Equal to
  • neq: Not equal to
  • gt: Greater than
  • gte: Greater than or equal
  • lt: Less than
  • lte: Less than or equal

Supported fields:

  • id: Entry ID
  • product_id: Filter by copilot/product ID
  • key: Filter by field key/name
  • data_type: Filter by data type (0-5)
  • type: Filter by type (0=expertise, 1=asset)
integer

Page number

integer
1 to 10000
Defaults to 100

Maximum number of results to return per page. Defaults to 100 if not specified. Maximum is 10,000. The response includes a more field indicating whether additional pages are available.

string

Fields to sort by

Responses

Updated 3 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago