nextstep

Showing 25 of 30 from the live probe.

• Get Schema

  Returns the NextStep data schema — call this before using create_template, create_template_task, or create_scheduled_run if you need to know the available field types, custom element types (shortText, dropdown, etc.), or scheduling options. Not needed for simple operations like listing or completing tasks.

• List Templates

  List process templates for your team. Use query to search by name.

• Get Template

  Get a process template by ID, including its sections.

• Create Template

  Create a new unpublished process template.

• Update Template

  Update an unpublished process template. Only title, description, and sections can be changed. Fails if the template is published — unpublish it first.

• Publish Template

  Publish or unpublish a process template. A template must be published before runs can be created from it.

• List Template Tasks

  List tasks belonging to a process template, ordered by position.

• Create Template Task

  Add a task to an unpublished process template. Supports rich content: input fields, instructional text/images, and file attachments. For 'image'/'video' elements, pass imageUrl (external URLs are fetched and re-hosted in Firebase Storage, 15MB cap). For 'file'/'attachment', pass fileUrl. Use get_schema for the full list of element types.

• Update Template Task

  Update a task in an unpublished process template. Can change title, position, assignee, and the full content array (form fields + instructional images/text/files). Passing custom_elements replaces the entire content. External imageUrl / fileUrl values are fetched and re-hosted in Firebase Storage (15MB cap); already-hosted URLs pass through unchanged.

• Delete Template

  Delete a process template and all its tasks. Cannot delete a published template — unpublish it first.

• Delete Template Task

  Delete a task from an unpublished process template.

• List Runs

  List process runs (instances) for your team with progress. Filter by template, status, or assignee.

• Get Run

  Get a process run by ID, including progress summary (total tasks, completed, percentage).

• Create Run

  Start a new process run from a published template. Creates instance tasks for every template task. A run inherits its tasks and form fields (custom_elements) from the template at creation time — to push template changes into future runs, unpublish (publish_template { published: false }), edit, then republish. Pass actor_email (an active team member's email) to attribute the run to that person so it appears in their Personal tab; otherwise it's attributed to you, the calling user. To invite an ex

• Invite Guest To Run

  Share an existing run with an external customer (guest), and optionally invite them by email — the API equivalent of the app's "Share via Email". Always enables link sharing on the run and returns the guest-accessible share_url. If you pass email, we also send the same branded invitation email the app sends and record the guest against the run. Omit email to just get the share_url back without sending anything (e.g. when you deliver the link yourself). A run can have one guest; team members are

• Update Run

  Update a process run — rename it or change its due date.

• Delete Run

  Delete a process run and all its instance tasks.

• List Run Tasks

  List tasks for a process run with completion status and assignees.

• Get Run Task

  Get details of a specific task in a process run, including form fields (custom elements) and their current values.

• Complete Task

  Mark a task as completed or uncompleted in a process run. If all tasks are completed, the run is automatically marked as completed.

• Assign Task

  Assign or unassign a team member to a task in a process run.

• Update Task Fields

  Fill in form fields (custom elements) on a task without completing it. Use get_run_task first to see available fields and their IDs.

• List Scheduled Runs

  List all scheduled (recurring) process runs for your team.

• Create Scheduled Run

  Schedule a recurring process run. The run will automatically create instances on the specified schedule. Use get_schema to see all scheduling options.

• Delete Scheduled Run

  Delete a scheduled process run.