Join the first BoxWorks Hackathon for Good - customers, partners, and the developer community are welcome to participate in the 48 hour Hack to benefit The Nature Conservancy.

Learn more and register!

Workflow (Mini)

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.


The unique identifier for the workflow


Value is always workflow

This workflow sets off a new hire approval flow

The description for a workflow.


Specifies if this workflow is enabled

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"