API reference / Tasks and projects
Get a template
One template, with how it works in numbered steps. A ready skill also gives the teammate to ask and the message that asks it to write the skill.
/api/v1/templates/{id}Other ways to call it
troopy templates gettroopy_get_templatePath parameters
id*stringA template's id, like weekly-brief or welcome-note. GET /templates lists them
At most 64 characters
Response
200 · application/jsondata*object21 properties
id*stringA template's id, like weekly-brief or welcome-note. GET /templates lists them
At most 64 characters
kind*enum<string>routine: a routine on a schedule that a teammate does by itself. trigger: work that a teammate does each time that something happens in Troopy. skill: a ready skill, which a teammate writes for the troop when you ask it. builtin: work that Troopy does itself, with no schedule
routineskillbuiltintrigger
title*stringabout*stringWhat it does, in one line
role*stringThe role that does it, like churn
roleTitle*stringavatar*objectIts face: a bot-avatars body type, colour (#RRGGBB), face and shading, a robot head, or an object with two eyes
6 properties
shape*enum<string>cloverflowertrianglesquareblobghostcircledropstardroidmechalienhexagoncatcloudpilland 2 more
color*stringface*enum<string>eyesmouth
shadingenum<string>How its body is lit; fabric when unset
fabricplasticcrispsmoothflat
robotobjectA TV-headed robot (robot-heads) in place of the bot. shape, color, face and shading stay for the bot
5 properties
shape*enum<string>rectanglesquarecirclehexagon
shell*stringThe colour of its shell
trim*stringThe colour of its ears and of the collar of its antenna
screen*stringThe colour of the lights on its screen
antenna*booleanobjectobjectAn object with two eyes in place of the bot. shape, color, face and shading stay for the bot
2 properties
shape*enum<string>circlesquaretrianglepilldrophexagonpentagoncloudbeancloverflowersparkleburstapplechatbulband 13 more
color*stringThe colour of the object
agent*string | nullThe handle of the teammate that does it. Null when nobody holds its role yet
agentName*string | nullskill*stringThe skill that it follows. Empty for a built-in template
when*stringA routine: its days and time. A ready skill: when a teammate uses it. A built-in template or a trigger: what starts it
needs*array<object>Apps its tools read from; it can't work until each is connected (POST /apps/{provider})
3 properties
id*enum<string>stripeposthoggithubnotionhunterlemonsqueezypolarpaddledodopaymentssearchconsolemetaadsgooglecalendargeminiopenaifalreplicate
name*stringconnected*booleanuses*array<object>What it uses. ready: the service is connected, a payment provider is connected (payments), or a mailbox has Read all on (mailbox). Null when there is nothing to set up
3 properties
id*enum<string>braintaskswebbrowserinboxmailboxcrmcampaignsanalyticspaymentsstripedodopaymentspaddleposthogsearchconsolemetaadsand 1 more
name*stringready*boolean | nullon*booleanA routine template: its routine exists. A trigger: its trigger exists. A ready skill: the workspace has a skill with its name. A built-in template: it is on
paused*booleanIts routine or its trigger is paused, or its skill is off
routineId*string | nullA routine template that is on: its routine
page*string | nullA built-in template: the page of its work in the app, like /disputes. A trigger that is on: the page of its trigger. Null for the others
steps*stringHow it works, in three to five numbered steps for people, each a title and a sentence. A routine's teammate follows the whole skill named in skill. A ready skill's teammate starts from these steps
outcomes*array<string>What you get, in three short lines
sample*objectA made-up example of what it makes, to show its shape
3 properties
kind*enum<string>emailreportlistpostbriefchat
label*stringlines*array<string>ask*object | nullA ready skill: send message to that teammate (POST /threads) and it proposes the skill, which a person approves. The teammate of its role gets it, or else the lead. Null for the others
3 properties
agent*stringname*stringmessage*string