---
title: "Retrieve workflow step"
method: GET
path: "/v2/workflows/{workflowId}/steps/{stepId}"
tags: ["Workflows"]
---

# Retrieve workflow step

`GET /v2/workflows/{workflowId}/steps/{stepId}`

## Request

- Base URL: `https://api.notifly.io`
- URL: `https://api.notifly.io/v2/workflows/{workflowId}/steps/{stepId}`
- Auth: API key in header `Authorization`

Retrieves data for a specific step in a workflow

## Path parameters

- `workflowId` string, required
- `stepId` string, required

## Response `200`

OK

- object
  - `data` StepResponseDto
    - `controls` ControlsMetadataDto, required
      - `dataSchema` object: JSON Schema for data
      - `uiSchema` UiSchema
        - `group` 'IN_APP' | 'EMAIL' | 'DIGEST' | 'DELAY' | 'THROTTLE' | 'SMS' | 'CHAT' | 'PUSH' | 'TOOL' | 'SKIP' | 'LAYOUT' | 'HTTP_REQUEST': Group of the UI Schema
        - `properties` object: Properties of the UI Schema
    - `controlValues` object: Control values for the step (alias for controls.values)
    - `providerOverrides` object, nullable: Per-provider content overrides keyed by providerId. Stored separately from controlValues and merged over the default body at send time. Keys are ChatProviderIdEnum / ToolProviderIdEnum values (e.g. `slack`, `whatsapp-business`, `pagerduty`).
    - `variables` object, required: JSON Schema for variables, follows the JSON Schema standard
    - `stepId` string, required: Unique identifier of the step
    - `_id` string, required: Database identifier of the step
    - `name` string, required: Name of the step
    - `slug` string, required: Slug of the step
    - `type` 'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool' | 'digest' | 'trigger' | 'delay' | 'throttle' | 'custom' | 'http_request', required: Type of the step
    - `origin` 'novu-cloud' | 'novu-cloud-v1' | 'external', required: Origin of the layout
    - `workflowId` string, required: Workflow identifier
    - `workflowDatabaseId` string, required: Workflow database identifier
    - `issues` StepIssuesDto
      - `controls` object: Controls-related issues
      - `integration` object: Integration-related issues
    - `stepResolverHash` string: Hash identifying the deployed Cloudflare Worker for this step

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `405`: Method Not Allowed
- `409`: Conflict
- `413`: Payload Too Large
- `414`: URI Too Long
- `415`: Unsupported Media Type
- `422`: Unprocessable Entity
- `429`: The client has sent too many requests in a given amount of time.
- `500`: Internal Server Error
- `503`: The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.

---

[API](https://skmtc.dev/notifly/apis/notifly-api.md) · [All operations](https://skmtc.dev/notifly/apis/notifly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/notifly/apis/notifly-api/revisions/af909b9e1e57?raw)