Skip to content
Hivelight API Documentation

Get workflow

GET
/workflows/{workflowId}

Fetch details of a specific workflow by ID.

Parameters

Path Parameters

workflowId
required
string

The ID of the workflow to retrieve.

Responses

200

A single workflow

object
data
object
type
string
id
string
attributes
object
name

Name of the matter

string
description

Description of the matter

string
types

A list of matter type identifiers for this matter

Array<string>
jurisdictions

A list of Jurisdictions this matter is associated with

Array<string>

404

Workflow not found

object
errors
Array<object>
object
status
string
404
title
string
Not Found
detail
string
Workflow with ID {workflowId} not found.

500

Internal Server Error

object
errors
Array<object>
object
status
string
500
title
string
Internal Server Error
detail
string
An unexpected error occurred.