Get a workflow
curl --request GET \
--url https://app.trelica.com/api/workflows/v1/{workflowId} \
--header 'Authorization: Bearer <token>'{
"next": "https://app.trelica.com/api/workflows/v1?after=eyJpZCI6ImI3Mjg4YzJjNjRmNzc5ZTI4MDI0ZWEwZSJ9&limit=100",
"results": [
{
"id": "b7288c2c64f779e28024ea0e",
"name": "Offboarding",
"enabled": true,
"createdDtm": "2023-06-22T14:02:36.136Z",
"deleted": false,
"lastModifiedBy": {
"userId": "b2c3d4e5-f678-90ab-cdef-1234567890ab",
"name": "Priya Patel",
"email": "priya.patel@example.com"
},
"lastModifiedDtm": "2023-06-22T20:28:35.846Z",
"trigger": {
"id": "5e0e8a1c64f779e28024ea0d",
"name": "Person leaves",
"type": "PersonLeaves"
},
"steps": [
{
"id": "4f2f9f6850fb2ce64a8ffb04",
"name": "Create task",
"type": "CreateTask"
},
{
"id": "f82c5f04e4b54a96f20ff8b5",
"name": "Create Jira (Cloud) ticket",
"type": "CreateExternalTask"
},
{
"id": "f9bff20456884e0f2c2f65ab",
"name": "Offboard person from apps",
"type": "OffboardPersonApps"
}
]
}
]
}Workflows
Get a workflow
Returns the published workflow with the given ID, including its trigger and steps. The workflow is returned inside a one-item result page (empty if no workflow has that ID).
Required scope: Workflows.Read (Read-only access to workflow definitions)
GET
/
api
/
workflows
/
v1
/
{workflowId}
Get a workflow
curl --request GET \
--url https://app.trelica.com/api/workflows/v1/{workflowId} \
--header 'Authorization: Bearer <token>'{
"next": "https://app.trelica.com/api/workflows/v1?after=eyJpZCI6ImI3Mjg4YzJjNjRmNzc5ZTI4MDI0ZWEwZSJ9&limit=100",
"results": [
{
"id": "b7288c2c64f779e28024ea0e",
"name": "Offboarding",
"enabled": true,
"createdDtm": "2023-06-22T14:02:36.136Z",
"deleted": false,
"lastModifiedBy": {
"userId": "b2c3d4e5-f678-90ab-cdef-1234567890ab",
"name": "Priya Patel",
"email": "priya.patel@example.com"
},
"lastModifiedDtm": "2023-06-22T20:28:35.846Z",
"trigger": {
"id": "5e0e8a1c64f779e28024ea0d",
"name": "Person leaves",
"type": "PersonLeaves"
},
"steps": [
{
"id": "4f2f9f6850fb2ce64a8ffb04",
"name": "Create task",
"type": "CreateTask"
},
{
"id": "f82c5f04e4b54a96f20ff8b5",
"name": "Create Jira (Cloud) ticket",
"type": "CreateExternalTask"
},
{
"id": "f9bff20456884e0f2c2f65ab",
"name": "Offboard person from apps",
"type": "OffboardPersonApps"
}
]
}
]
}Authorizations
OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as Authorization: Bearer <token>.
Path Parameters
Was this page helpful?
⌘I