Box Developer Documentation
Log in

Workflow (Mini)

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

Box Relay Workflows are objects that represent a named collection of flows.

You application must be authorized to use the Manage Box Relay application scope within the developer console in order to use this resource.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the mini variant are generally returned when the resource is nested within the response for another resource.

string
11446498

The unique identifier for the workflow.

string
workflow

The value will always be workflow.

Value is always workflow

string
This workflow sets off a new hire approval flow

The description for a workflow.

boolean
true

Specifies if this workflow is enabled.

string
New Hire Workflow

The name of the workflow.

Response Example

{
  "id": "11446498",
  "type": "workflow",
  "description": "This workflow sets off a new hire approval flow",
  "is_enabled": true,
  "name": "New Hire Workflow"
}