trickroom / Docs
Sign in
API reference/plugins

List available plugins and their permissions

GET/v1/applications/{id}/plugins

Authorization

Authorizationstringrequired

Bearer tak_… — an application API key. Keep it on your backend; all resources are scoped to that application.

Create an application key →

Path parameters

idstringrequired

Min length: 1

Response

200List available plugins and their permissions
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

application_idstringrequired

Min length: 1

dataarray<object>required
Item fields
idstringrequired

Allowed: "gmail""web""github""drive""calendar""slack""figma"

namestringrequired
descriptionstringrequired
actionsarray<string>required
connectionstringrequired

Allowed: "oauth""token""none"

configuredbooleanrequired
connect_availablebooleanrequired
installationobject | nullrequired
Allowed shapes

object

application_idstringrequired

Min length: 1

plugin_idstringrequired

Allowed: "gmail""web""github""drive""calendar""slack""figma"

permissionstringrequired

Allowed: "allow_reads""ask""disabled"

revisionintegerrequired

Minimum: -9007199254740991 · Maximum: 9007199254740991

null

valuenull

Additional keys: any

templatesarray<object>required
Item fields
namestringrequired

Min length: 1 · Max length: 100

definitionobjectrequired
Object fields
descriptionstring

Default: "" · Max length: 1000

pluginsarray<string>required

Max items: 7

execution_modestring

Allowed: "computer""tools"

Default: "tools"

inputsarray<object>required

Max items: 10

Item fields
namestringrequired

Pattern: ^[a-z][a-z0-9_]{0,39}$

labelstringrequired

Min length: 1 · Max length: 100

stepsarray<string>required

Min items: 1 · Max items: 10

outputstringrequired

Min length: 1 · Max length: 1000

4XX400 invalid input; 401 missing/revoked credentials; 403 disallowed operation/application; 404 missing or inaccessible resource; 409 conflicting submission/version/state; 413 body too large; 415 unsupported content type. Inspect error.code, not message text.
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired
Object fields
codestringrequired
messagestringrequired
request_idstringrequired

Additional keys: any

5XX500 unexpected failure or 503 unavailable dependency. A failed response does not prove that a submission was not committed. Retry job/flow admission with the same key and body.
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired
Object fields
codestringrequired
messagestringrequired
request_idstringrequired

Additional keys: any