Skip to content
Pile
Esc
↑↓navigate↵open⌘Jpreview

Get stage template

GET/workspaces/{organizationId}/stage-templates/{id}
Path parameters
organizationIdstringrequired
idstringrequired
Responses
200

Stage template

templateStageTemplaterequired
Show properties
idstringrequired
organizationIdstringrequired
entityTypestringrequired
Allowed:issuedealcustomer
statusstringrequired
stepKeystringrequired
titlestringrequired
requiredbooleanrequired
ownerAgentstring | nullrequired
conditionobject | nullrequired

Optional gate — {field} creates the step only when the record's field (column or custom field) is truthy; {field, equals} compares for equality. Field names normalize: "Hardware needed" == "hardware_needed".

Show properties
fieldstringrequired
min length 1
equalsstring | number | boolean
Show properties
Any of:
string
string
number
number
boolean
boolean
positionintegerrequired
teamIdstring | nullrequired
createdBystring | nullrequired
createdAtstringrequired
updatedAtstringrequired
404

Stage template not found

Try it
Server
Parameters
Request
curl -X GET '/workspaces/string/stage-templates/string' \
  -H 'Accept: application/json'
Response
{
  "template": {
    "id": "string",
    "organizationId": "string",
    "entityType": "issue",
    "status": "string",
    "stepKey": "string",
    "title": "string",
    "required": true,
    "ownerAgent": "string",
    "condition": {
      "field": "string",
      "equals": "string"
    },
    "position": 0,
    "teamId": "string",
    "createdBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Was this page helpful?