Skip to main content

GET /workflowsets/:id

A GET to the /workflowsets/:id endpoint allows your application to fetch a specific workflow set by it's identifier.

Workflow sets are coupled pickup and delivery workflows that are meant to be used together. These sets are given a name and made available to customize the behavior of the pickup and delivery process for a move. These must be created by HopDrive personnel, but once created, they will be retrievable by this endpoint. Use the ID of one of these sets to override the default workflow set when creating a move.

Requests made to this endpoint require an authorization header using your authentication token:

curl --request GET \
  --url https://api.hopdrive.com/v1/workflowsets/:id \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <your token>'

Request​

GET /v1/workflowsets/9

Response​

200 /v1/workflowsets/9
{
  "id": 9,
  "name": "Test Workflow Set",
  "description": "Test workflow set description"
}