curl --request GET \
--url https://app.trelica.com/api/workflows/v1 \
--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"
}
]
}
]
}List workflows
Returns a paginated list of the published workflows in your organization, including each
workflow’s trigger and steps. Use filter and q to narrow the results, and
follow the next link (also provided in the link response header) to page
through large result sets.
Required scope: Workflows.Read (Read-only access to workflow definitions)
curl --request GET \
--url https://app.trelica.com/api/workflows/v1 \
--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>.
Query Parameters
A SCIM-style filter expression restricting the items returned. See the Filtering section of the introduction for the operators and syntax; the filterable fields are listed per resource.
Filterable fields
- string:
createdBy.email,createdBy.name,createdBy.userId,id,lastModifiedBy.email,lastModifiedBy.name,lastModifiedBy.userId,name,steps[customName],steps[id],steps[name],steps[type],trigger.dayOfWeek,trigger.id,trigger.name,trigger.period,trigger.type - number:
trigger.everyNPeriods,trigger.hour - date:
createdDtm,lastModifiedDtm,trigger.startDate - boolean:
deleted,enabled
Filter examples
name eq "Onboarding workflow"— The workflow named "Onboarding workflow"name sw "Contr"— Workflows whose name starts with "Contr", e.g. "Contractor offboarding"trigger.type eq "PersonFilter"— Workflows triggered by a person filterenabled eq true— Workflows that are enabledlastModifiedDtm ge "2022-01-01"— Workflows modified on or after 1 Jan 2022deleted eq true— Show deleted workflows (excluded by default)
Free-text search across the resource's displayable fields.
Only return items modified at or after this ISO-8601 timestamp.
Only return items modified at or before this ISO-8601 timestamp.
Opaque pagination cursor supplied by SaaS Manager via the link response header and the next field.
Maximum number of items to return per page (default 100, maximum 1000).
1 <= x <= 1000Was this page helpful?