Skip to content

Rippling: Retrieve a workflow

Rippling restApi.getWorkflows: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.get_workflows

Provider route: GET /workflows/{id}/. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["getWorkflows"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.getWorkflows(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.get_workflows(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.version_idstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a workflow — response body

Referenced models: Create a workflow — response body

16 more schemas are linked from the tables above, on the schema pages.

Create a workflow — response body
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
authoringModelRequired within parentExpand Create a workflow — response body — authoring
created_atstringRequired within parentFormat: date-time
definitionJSONRequired within parent
definition (anyOf 1)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable
definition (anyOf 2)ModelAlternativeExpand Create a workflow — response body — definition / kind: read only
deletablebooleanRequired within parent
descriptionJSONOptional
description (anyOf 1)stringAlternative
description (anyOf 2)nullAlternative
enabledbooleanRequired within parent
has_draftbooleanRequired within parent
idstringRequired within parent
namestringRequired within parent
owner_idstringRequired within parent
statusstringRequired within parentKnown values: draft, published, unknown
updated_atstringRequired within parentFormat: date-time
version_idstringRequired within parent

Referenced models: Create a workflow — response body — definition / kind: editable, Create a workflow — response body — definition / kind: read only, Create a workflow — response body — authoring

Create a workflow — response body — definition / kind: editable
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
actionsarrayRequired within parentMaximum items: 160
Minimum items: 1
actions[]JSONEach item
actions[] (anyOf 1)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable actions item kind: registered callback
kindstringRequired within parentKnown values: editable
triggerJSONRequired within parent
trigger (anyOf 1)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: daily schedule
trigger (anyOf 2)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: business event
trigger (anyOf 3)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: weekday schedule
trigger (anyOf 4)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: weekly schedule
trigger (anyOf 5)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: biweekly schedule
trigger (anyOf 6)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: monthly schedule
trigger (anyOf 7)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: monthly on day of week schedule
trigger (anyOf 8)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: quarterly schedule
trigger (anyOf 9)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: annual schedule
trigger (anyOf 10)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: one time schedule
trigger (anyOf 11)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: custom schedule, unit: minutes, hours, days, weeks, months, years
trigger (anyOf 12)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: cron schedule
trigger (anyOf 13)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: manual
trigger (anyOf 14)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger event type: message posted, reaction added, kind: slack
trigger (anyOf 15)ModelAlternativeExpand Create a workflow — response body — definition / kind: editable trigger kind: inbound email

Referenced models: Create a workflow — response body — definition / kind: editable trigger kind: annual schedule, Create a workflow — response body — definition / kind: editable trigger kind: biweekly schedule, Create a workflow — response body — definition / kind: editable trigger kind: business event, Create a workflow — response body — definition / kind: editable trigger kind: cron schedule, Create a workflow — response body — definition / kind: editable trigger kind: custom schedule, unit: minutes, hours, days, weeks, months, years, Create a workflow — response body — definition / kind: editable trigger kind: daily schedule, Create a workflow — response body — definition / kind: editable trigger kind: inbound email, Create a workflow — response body — definition / kind: editable trigger kind: manual, Create a workflow — response body — definition / kind: editable trigger kind: monthly on day of week schedule, Create a workflow — response body — definition / kind: editable trigger kind: monthly schedule, Create a workflow — response body — definition / kind: editable trigger kind: one time schedule, Create a workflow — response body — definition / kind: editable trigger kind: quarterly schedule, Create a workflow — response body — definition / kind: editable actions item kind: registered callback, Create a workflow — response body — definition / kind: editable trigger event type: message posted, reaction added, kind: slack, Create a workflow — response body — definition / kind: editable trigger kind: weekday schedule, Create a workflow — response body — definition / kind: editable trigger kind: weekly schedule

Create a workflow — response body — definition / kind: read only
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
kindstringRequired within parentKnown values: read_only
stepsarrayRequired within parent
steps[]ModelEach itemExpand Create a workflow — response body — definition / kind: read only steps item
triggerModelRequired within parentExpand Create a workflow — response body — definition / kind: read only trigger

Referenced models: Create a workflow — response body — definition / kind: read only steps item, Create a workflow — response body — definition / kind: read only trigger

Create a workflow — response body — authoring
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
modestringRequired within parentKnown values: full, metadata_only, read_only
patchable_fieldsarrayRequired within parent
patchable_fields[]stringEach itemKnown values: name, description, status, enabled, trigger, actions
reason_codesarrayRequired within parent
reason_codes[]stringEach itemKnown values: unsupported_trigger, unsupported_graph, insufficient_permission, missing_current_version
Create a workflow — response body — definition / kind: editable trigger kind: business event
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
event_namestringRequired within parent
kindstringRequired within parentKnown values: business_event
Create a workflow — response body — definition / kind: editable trigger kind: manual
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
kindstringRequired within parentKnown values: manual

SDK function policy ID: rippling.rest_api.get_workflows. Catalog operation: get-workflows. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["workflows.read"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.