Get product details | Runtype Documentation

Get a product by ID including its capabilities and surfaces.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Query parameters

includeEditorContextstringOptional

Response

Product details

capabilitieslist of any

createdAtstring

createdByUserIdstring or null

Who created the product; attribution only, never who owns or runs it (the organization does)

descriptionstring or null

externalSourceobject or null

What a Runs elsewhere product was imported from; null for any other product

iconstring or null

idstring

kindenum

Derived on read: external (Runs elsewhere) for a product imported from a server it does not run, spec_only for one with no capability and no surface, otherwise runtype

Allowed values:

namestring

surfaceslist of any

updatedAtstring

canvasanyOptional

configurationStatusanyOptional

configurationUrlstring or nullOptional

dashboardUrlstringOptional

editorContextobjectOptional

pendingConfigurationCountintegerOptional

specanyOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error