List Workflows

Request

GET /v2/workflows HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter Description
mailboxId List workflows associated with specified mailboxId
type List workflows by type - manual or automatic
page Page number

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8

{
  "_embedded" : {
    "workflows" : [ {
      "id" : 1234,
      "mailboxId" : 100,
      "type" : "manual",
      "status" : "active",
      "order" : 1,
      "name" : "Mine",
      "createdAt" : "2012-07-24T20:13:12Z",
      "modifiedAt" : "2012-07-24T20:18:33Z",
      "_links" : {
        "self" : {
          "href" : "..."
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "page" : {
      "href" : "...",
      "templated" : true
    },
    "self" : {
      "href" : "..."
    }
  },
  "page" : {
    "size" : 50,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 1
  }
}

Workflow

Path Type Description
[].id Number Unique workflow identifier
[].mailboxId Number Mailbox ID that the workflow is associated with
[].type String Always manual via the API, there are automatic workflows within the app
[].status String Current status of the workflow. Valid values are [active,inactive,invalid]
[].order Number The order of the workflow
[].name String Name of the workflow
[].createdAt String UTC time when the workflow was created
[].modifiedAt String UTC time when the workflow was last modified