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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.id | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.version_id | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create a workflow — response body |
Referenced models: Create a workflow — response body
Schemas
Section titled “Schemas”16 more schemas are linked from the tables above, on the schema pages.
Create a workflow — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
authoring | Model | Required within parent | Expand Create a workflow — response body — authoring |
created_at | string | Required within parent | Format: date-time |
definition | JSON | Required within parent | |
definition (anyOf 1) | Model | Alternative | Expand Create a workflow — response body — definition / kind: editable |
definition (anyOf 2) | Model | Alternative | Expand Create a workflow — response body — definition / kind: read only |
deletable | boolean | Required within parent | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
enabled | boolean | Required within parent | |
has_draft | boolean | Required within parent | |
id | string | Required within parent | |
name | string | Required within parent | |
owner_id | string | Required within parent | |
status | string | Required within parent | Known values: draft, published, unknown |
updated_at | string | Required within parent | Format: date-time |
version_id | string | Required 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
kind | string | Required within parent | Known values: read_only |
steps | array | Required within parent | |
steps[] | Model | Each item | Expand Create a workflow — response body — definition / kind: read only steps item |
trigger | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
mode | string | Required within parent | Known values: full, metadata_only, read_only |
patchable_fields | array | Required within parent | |
patchable_fields[] | string | Each item | Known values: name, description, status, enabled, trigger, actions |
reason_codes | array | Required within parent | |
reason_codes[] | string | Each item | Known values: unsupported_trigger, unsupported_graph, insufficient_permission, missing_current_version |
Create a workflow — response body — definition / kind: editable trigger kind: business event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
event_name | string | Required within parent | |
kind | string | Required within parent | Known values: business_event |
Create a workflow — response body — definition / kind: editable trigger kind: manual
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
kind | string | Required within parent | Known values: manual |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}