{"info":{"title":"Manifestly","description":"Utilize your Manifestly Checklists via the API. Each request requires the api_key parameter. Your API Key can be found at \u003ca href=\"https://app.manifest.ly/profile?section=api\"\u003eyour Manifestly profile page\u003c/a\u003e.\n\nPlease note: **checklist_id** refers to the **ID of a Workflow** in Manifestly. We renamed checklists to workflows in the user interface, but kept with the same IDs.\n\n## Authentication\n\nManifestly authenticates API requests using an API key. Each request must include the API key in the HTTP `Authorization` header.\n\n### How to Use the API Key\n\nAuthorization: YOUR_API_KEY\n\nReplace `YOUR_API_KEY` with an API key found in your Manifestly [Account Settings Page](https://app.manifest.ly/account?section=integrations)\n\nIf the API key is invalid or missing, the server will return a `401 Unauthorized` response.\n\n### Where to Create an API Key\n\nMaster admins can create and manage API keys on their\n[Manifestly Account Settings Page](https://app.manifest.ly/account?section=integrations).","version":"1.0.0"},"swagger":"2.0","produces":["application/json"],"host":"api.manifest.ly","basePath":"/api/v1","schemes":["https"],"tags":[{"name":"checklists","description":"Operations about checklists"},{"name":"notifications","description":"Operations about notifications"},{"name":"departments","description":"Operations about departments"},{"name":"runs","description":"Operations about runs"},{"name":"memberships","description":"Operations about memberships"},{"name":"users","description":"Operations about users"},{"name":"assignments","description":"Operations about assignments"},{"name":"hooks","description":"Operations about hooks"},{"name":"zapier_polling","description":"Operations about zapier_pollings"}],"paths":{"/checklists":{"get":{"summary":"List workflows","description":"List workflows","produces":["application/json"],"parameters":[{"in":"query","name":"tag","description":"Tag","type":"string","required":false}],"responses":{"200":{"description":"List workflows"}},"tags":["checklists"],"operationId":"getChecklists"},"post":{"summary":"Create Workflow","description":"Create Workflow","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postChecklists","in":"body","required":true,"schema":{"$ref":"#/definitions/postChecklists"}}],"responses":{"201":{"description":"Create Workflow"}},"tags":["checklists"],"operationId":"postChecklists"},"delete":{"summary":"Deactivate a workflow by external ID","description":"Deactivate a workflow by external ID","produces":["application/json"],"parameters":[{"in":"query","name":"external_id","description":"External ID","type":"string","required":true}],"responses":{"204":{"description":"Deactivate a workflow by external ID"}},"tags":["checklists"],"operationId":"deleteChecklists"}},"/checklists/archived":{"get":{"summary":"List archived workflows","description":"List archived workflows","produces":["application/json"],"responses":{"200":{"description":"List archived workflows"}},"tags":["checklists"],"operationId":"getChecklistsArchived"}},"/checklists/import":{"post":{"summary":"Import a checklist from a JSON","description":"Import a checklist from a JSON","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postChecklistsImport","in":"body","required":true,"schema":{"$ref":"#/definitions/postChecklistsImport"}}],"responses":{"201":{"description":"Import a checklist from a JSON"}},"tags":["checklists"],"operationId":"postChecklistsImport"}},"/checklists/{id}":{"get":{"summary":"Show workflow","description":"Show workflow","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Show workflow"}},"tags":["checklists"],"operationId":"getChecklistsId"},"put":{"summary":"Update a workflow","description":"Update a workflow","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"name":"putChecklistsId","in":"body","required":true,"schema":{"$ref":"#/definitions/putChecklistsId"}}],"responses":{"200":{"description":"Update a workflow"}},"tags":["checklists"],"operationId":"putChecklistsId"},"delete":{"summary":"Deactivate a workflow","description":"Deactivate a workflow","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Deactivate a workflow"}},"tags":["checklists"],"operationId":"deleteChecklistsId"}},"/checklists/{id}/comments":{"post":{"summary":"Add a comment to a workflow","description":"Add a comment to a workflow","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Add a comment to a workflow"}},"tags":["checklists"],"operationId":"postChecklistsIdComments"}},"/checklists/{id}/steps":{"post":{"summary":"Create a Workflow Step","description":"Create a Workflow Step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"name":"postChecklistsIdSteps","in":"body","required":true,"schema":{"$ref":"#/definitions/postChecklistsIdSteps"}}],"responses":{"201":{"description":"Create a Workflow Step"}},"tags":["checklists"],"operationId":"postChecklistsIdSteps"},"get":{"summary":"List steps","description":"List steps","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List steps"}},"tags":["checklists"],"operationId":"getChecklistsIdSteps"}},"/checklists/{id}/hooks":{"get":{"summary":"List hooks","description":"List hooks","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"query","name":"target_url","description":"Target URL for Web Hook","type":"string","required":false},{"in":"query","name":"event","description":"Event for Web Hook","type":"string","required":false}],"responses":{"200":{"description":"List hooks"}},"tags":["checklists"],"operationId":"getChecklistsIdHooks"},"post":{"summary":"Create a hook","description":"Create a hook","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"name":"postChecklistsIdHooks","in":"body","required":true,"schema":{"$ref":"#/definitions/postChecklistsIdHooks"}}],"responses":{"201":{"description":"Create a hook"}},"tags":["checklists"],"operationId":"postChecklistsIdHooks"}},"/checklists/{id}/hooks/unsubscribe":{"post":{"summary":"Delete a hook","description":"Delete a hook","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"name":"postChecklistsIdHooksUnsubscribe","in":"body","required":true,"schema":{"$ref":"#/definitions/postChecklistsIdHooksUnsubscribe"}}],"responses":{"201":{"description":"Delete a hook"}},"tags":["checklists"],"operationId":"postChecklistsIdHooksUnsubscribe"}},"/checklists/{id}/steps/{step_id}":{"get":{"summary":"Show step","description":"Show step","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Show step"}},"tags":["checklists"],"operationId":"getChecklistsIdStepsStepId"},"put":{"summary":"Update a Workflow Step","description":"Update a Workflow Step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true},{"name":"putChecklistsIdStepsStepId","in":"body","required":true,"schema":{"$ref":"#/definitions/putChecklistsIdStepsStepId"}}],"responses":{"200":{"description":"Update a Workflow Step"}},"tags":["checklists"],"operationId":"putChecklistsIdStepsStepId"},"delete":{"summary":"Delete a Workflow Step","description":"Delete a Workflow Step","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a Workflow Step"}},"tags":["checklists"],"operationId":"deleteChecklistsIdStepsStepId"}},"/checklists/{id}/steps/{step_id}/content_objects":{"get":{"summary":"List Content Objects","description":"List Content Objects","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List Content Objects"}},"tags":["checklists"],"operationId":"getChecklistsIdStepsStepIdContentObjects"},"post":{"summary":"Create a Content Object","description":"Create a Content Object","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true},{"name":"postChecklistsIdStepsStepIdContentObjects","in":"body","required":true,"schema":{"$ref":"#/definitions/postChecklistsIdStepsStepIdContentObjects"}}],"responses":{"201":{"description":"Create a Content Object"}},"tags":["checklists"],"operationId":"postChecklistsIdStepsStepIdContentObjects"}},"/checklists/{id}/steps/{step_id}/content_objects/{content_object_id}":{"get":{"summary":"Show Content Object","description":"Show Content Object","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"content_object_id","description":"Content Object ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Show Content Object"}},"tags":["checklists"],"operationId":"getChecklistsIdStepsStepIdContentObjectsContentObjectId"},"put":{"summary":"Update Content Object","description":"Update Content Object","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"content_object_id","description":"Content Object ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true},{"name":"putChecklistsIdStepsStepIdContentObjectsContentObjectId","in":"body","required":true,"schema":{"$ref":"#/definitions/putChecklistsIdStepsStepIdContentObjectsContentObjectId"}}],"responses":{"200":{"description":"Update Content Object"}},"tags":["checklists"],"operationId":"putChecklistsIdStepsStepIdContentObjectsContentObjectId"},"delete":{"summary":"Delete Content Object","description":"Delete Content Object","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"content_object_id","description":"Content Object ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete Content Object"}},"tags":["checklists"],"operationId":"deleteChecklistsIdStepsStepIdContentObjectsContentObjectId"}},"/checklists/{id}/steps/{step_id}/hooks":{"get":{"summary":"List hooks","description":"List hooks","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"query","name":"event","type":"string","required":false},{"in":"query","name":"target_url","type":"string","required":false},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List hooks"}},"tags":["checklists"],"operationId":"getChecklistsIdStepsStepIdHooks"},"post":{"summary":"Create a hook","description":"Create a hook","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true},{"name":"postChecklistsIdStepsStepIdHooks","in":"body","required":true,"schema":{"$ref":"#/definitions/postChecklistsIdStepsStepIdHooks"}}],"responses":{"201":{"description":"Create a hook"}},"tags":["checklists"],"operationId":"postChecklistsIdStepsStepIdHooks"}},"/checklists/{id}/steps/{step_id}/hooks/unsubscribe":{"post":{"summary":"Delete a hook","description":"Delete a hook","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true},{"name":"postChecklistsIdStepsStepIdHooksUnsubscribe","in":"body","required":true,"schema":{"$ref":"#/definitions/postChecklistsIdStepsStepIdHooksUnsubscribe"}}],"responses":{"201":{"description":"Delete a hook"}},"tags":["checklists"],"operationId":"postChecklistsIdStepsStepIdHooksUnsubscribe"}},"/checklists/{id}/steps/{step_id}/data_setting":{"get":{"summary":"Get data setting for step","description":"Get data setting for step","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get data setting for step"}},"tags":["checklists"],"operationId":"getChecklistsIdStepsStepIdDataSetting"},"put":{"summary":"Create or update data setting for step","description":"Create or update data setting for step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true},{"name":"putChecklistsIdStepsStepIdDataSetting","in":"body","required":true,"schema":{"$ref":"#/definitions/putChecklistsIdStepsStepIdDataSetting"}}],"responses":{"200":{"description":"Create or update data setting for step"}},"tags":["checklists"],"operationId":"putChecklistsIdStepsStepIdDataSetting"},"delete":{"summary":"Delete data setting for step","description":"Delete data setting for step","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete data setting for step"}},"tags":["checklists"],"operationId":"deleteChecklistsIdStepsStepIdDataSetting"}},"/checklists/{id}/steps/{step_id}/data_settings":{"get":{"summary":"List data settings for step","description":"List data settings for step","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List data settings for step"}},"tags":["checklists"],"operationId":"getChecklistsIdStepsStepIdDataSettings"},"post":{"summary":"Add a data setting to step","description":"Add a data setting to step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true},{"name":"postChecklistsIdStepsStepIdDataSettings","in":"body","required":true,"schema":{"$ref":"#/definitions/postChecklistsIdStepsStepIdDataSettings"}}],"responses":{"201":{"description":"Add a data setting to step"}},"tags":["checklists"],"operationId":"postChecklistsIdStepsStepIdDataSettings"}},"/checklists/{id}/steps/{step_id}/data_settings/{data_setting_id}":{"get":{"summary":"Show a data setting","description":"Show a data setting","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true},{"in":"path","name":"data_setting_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Show a data setting"}},"tags":["checklists"],"operationId":"getChecklistsIdStepsStepIdDataSettingsDataSettingId"},"put":{"summary":"Update a data setting","description":"Update a data setting","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true},{"in":"path","name":"data_setting_id","type":"integer","format":"int32","required":true},{"name":"putChecklistsIdStepsStepIdDataSettingsDataSettingId","in":"body","required":true,"schema":{"$ref":"#/definitions/putChecklistsIdStepsStepIdDataSettingsDataSettingId"}}],"responses":{"200":{"description":"Update a data setting"}},"tags":["checklists"],"operationId":"putChecklistsIdStepsStepIdDataSettingsDataSettingId"},"delete":{"summary":"Delete a data setting","description":"Delete a data setting","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Workflow ID","type":"integer","format":"int32","required":true},{"in":"path","name":"step_id","type":"integer","format":"int32","required":true},{"in":"path","name":"data_setting_id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a data setting"}},"tags":["checklists"],"operationId":"deleteChecklistsIdStepsStepIdDataSettingsDataSettingId"}},"/notifications":{"post":{"summary":"Notification Settings","description":"Notification Settings","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postNotifications","in":"body","required":true,"schema":{"$ref":"#/definitions/postNotifications"}}],"responses":{"201":{"description":"Notification Settings"}},"tags":["notifications"],"operationId":"postNotifications"},"get":{"summary":"List Notification Settings","description":"List Notification Settings","produces":["application/json"],"responses":{"200":{"description":"List Notification Settings"}},"tags":["notifications"],"operationId":"getNotifications"}},"/departments":{"get":{"summary":"List departments","description":"List departments","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"List departments"}},"tags":["departments"],"operationId":"getDepartments"},"post":{"summary":"Create a department","description":"Create a department","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postDepartments","in":"body","required":true,"schema":{"$ref":"#/definitions/postDepartments"}}],"responses":{"201":{"description":"Create a department"}},"tags":["departments"],"operationId":"postDepartments"}},"/departments/{id}":{"put":{"summary":"Update a department","description":"Update a department","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true},{"name":"putDepartmentsId","in":"body","required":true,"schema":{"$ref":"#/definitions/putDepartmentsId"}}],"responses":{"200":{"description":"Update a department"}},"tags":["departments"],"operationId":"putDepartmentsId"},"delete":{"summary":"Delete a department","description":"Delete a department","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a department"}},"tags":["departments"],"operationId":"deleteDepartmentsId"}},"/runs":{"get":{"summary":"List visible runs","description":"List visible runs","produces":["application/json"],"parameters":[{"in":"query","name":"page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","type":"integer","format":"int32","required":false},{"in":"query","name":"status","type":"string","enum":["blocked","scheduled","preparing","started","completed","closed","archived","upcoming","in-progress","late","not-closed"],"required":false},{"in":"query","name":"title","type":"string","required":false},{"in":"query","name":"checklist_id","type":"integer","format":"int32","required":false},{"in":"query","name":"external_id","type":"string","required":false}],"responses":{"200":{"description":"List visible runs"}},"tags":["runs"],"operationId":"getRuns"},"post":{"summary":"Create a run","description":"Create a run","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postRuns","in":"body","required":true,"schema":{"$ref":"#/definitions/postRuns"}}],"responses":{"201":{"description":"Create a run"}},"tags":["runs"],"operationId":"postRuns"}},"/runs/sample_run":{"get":{"summary":"Get a sample run (Zapier integration)","description":"Get a sample run (Zapier integration)","produces":["application/json"],"responses":{"200":{"description":"Get a sample run (Zapier integration)"}},"tags":["runs"],"operationId":"getRunsSampleRun"}},"/runs/sample_run_step":{"get":{"summary":"Get a sample run step (Zapier integration)","description":"Get a sample run step (Zapier integration)","produces":["application/json"],"responses":{"200":{"description":"Get a sample run step (Zapier integration)"}},"tags":["runs"],"operationId":"getRunsSampleRunStep"}},"/runs/{run_id}":{"delete":{"summary":"Close a run","description":"Close a run","produces":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Close a run"}},"tags":["runs"],"operationId":"deleteRunsRunId"},"get":{"summary":"Show run","description":"Show run","produces":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Show run"}},"tags":["runs"],"operationId":"getRunsRunId"},"post":{"summary":"Update run","description":"Update run","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"name":"postRunsRunId","in":"body","required":true,"schema":{"$ref":"#/definitions/postRunsRunId"}}],"responses":{"201":{"description":"Update run"}},"tags":["runs"],"operationId":"postRunsRunId"}},"/runs/{run_id}/join":{"post":{"summary":"Join a run","description":"Join a run","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Join a run"}},"tags":["runs"],"operationId":"postRunsRunIdJoin"}},"/runs/{run_id}/start":{"post":{"summary":"Start a run","description":"Start a run","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Start a run"}},"tags":["runs"],"operationId":"postRunsRunIdStart"}},"/runs/{run_id}/run_steps":{"get":{"summary":"List Run Steps for a Run","description":"List Run Steps for a Run","produces":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List Run Steps for a Run"}},"tags":["runs"],"operationId":"getRunsRunIdRunSteps"}},"/runs/{run_id}/run_steps/{id}/assign":{"post":{"summary":"Assign run step","description":"Assign run step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true},{"name":"postRunsRunIdRunStepsIdAssign","in":"body","required":true,"schema":{"$ref":"#/definitions/postRunsRunIdRunStepsIdAssign"}}],"responses":{"201":{"description":"Assign run step"}},"tags":["runs"],"operationId":"postRunsRunIdRunStepsIdAssign"}},"/runs/{run_id}/run_steps/{id}/data":{"post":{"summary":"Save data for a run step","description":"Save data for a run step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true},{"name":"postRunsRunIdRunStepsIdData","in":"body","required":true,"schema":{"$ref":"#/definitions/postRunsRunIdRunStepsIdData"}}],"responses":{"201":{"description":"Save data for a run step"}},"tags":["runs"],"operationId":"postRunsRunIdRunStepsIdData"}},"/runs/{run_id}/run_steps/{id}/data_settings":{"get":{"summary":"List data settings for a run step","description":"List data settings for a run step","produces":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List data settings for a run step"}},"tags":["runs"],"operationId":"getRunsRunIdRunStepsIdDataSettings"}},"/runs/{run_id}/run_steps/{id}/data_settings/{data_setting_id}":{"get":{"summary":"Show a run step data setting","description":"Show a run step data setting","produces":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true},{"in":"path","name":"data_setting_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Show a run step data setting"}},"tags":["runs"],"operationId":"getRunsRunIdRunStepsIdDataSettingsDataSettingId"},"put":{"summary":"Save data for a specific data setting","description":"Save data for a specific data setting","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true},{"in":"path","name":"data_setting_id","type":"integer","format":"int32","required":true},{"name":"putRunsRunIdRunStepsIdDataSettingsDataSettingId","in":"body","required":true,"schema":{"$ref":"#/definitions/putRunsRunIdRunStepsIdDataSettingsDataSettingId"}}],"responses":{"200":{"description":"Save data for a specific data setting"}},"tags":["runs"],"operationId":"putRunsRunIdRunStepsIdDataSettingsDataSettingId"}},"/runs/{run_id}/run_steps/{id}/comments":{"get":{"summary":"List comments for a run step","description":"List comments for a run step","produces":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List comments for a run step"}},"tags":["runs"],"operationId":"getRunsRunIdRunStepsIdComments"},"post":{"summary":"Add a comment to a run step","description":"Add a comment to a run step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Add a comment to a run step"}},"tags":["runs"],"operationId":"postRunsRunIdRunStepsIdComments"}},"/runs/{run_id}/run_steps/{id}/comments/{comment_id}":{"delete":{"summary":"Delete a comment from a run step","description":"Delete a comment from a run step","produces":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true},{"in":"path","name":"comment_id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a comment from a run step"}},"tags":["runs"],"operationId":"deleteRunsRunIdRunStepsIdCommentsCommentId"}},"/runs/{run_id}/run_steps/{id}/complete":{"post":{"summary":"Complete a run step","description":"Complete a run step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Complete a run step"}},"tags":["runs"],"operationId":"postRunsRunIdRunStepsIdComplete"}},"/runs/{run_id}/run_steps/{id}/uncomplete":{"post":{"summary":"Uncomplete a run step","description":"Uncomplete a run step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Uncomplete a run step"}},"tags":["runs"],"operationId":"postRunsRunIdRunStepsIdUncomplete"}},"/runs/{run_id}/run_steps/{id}/skip":{"post":{"summary":"Skip a run step","description":"Skip a run step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Skip a run step"}},"tags":["runs"],"operationId":"postRunsRunIdRunStepsIdSkip"}},"/runs/{run_id}/run_steps/{id}/unskip":{"post":{"summary":"Unskip a run step","description":"Unskip a run step","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"run_id","type":"integer","format":"int32","required":true},{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Unskip a run step"}},"tags":["runs"],"operationId":"postRunsRunIdRunStepsIdUnskip"}},"/memberships":{"post":{"summary":"Create membership","description":"Create membership","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postMemberships","in":"body","required":true,"schema":{"$ref":"#/definitions/postMemberships"}}],"responses":{"201":{"description":"Create membership"}},"tags":["memberships"],"operationId":"postMemberships"}},"/memberships/{id}":{"get":{"summary":"Show membership","description":"Show membership","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Show membership"}},"tags":["memberships"],"operationId":"getMembershipsId"},"put":{"summary":"Update a membership","description":"Update a membership","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true},{"name":"putMembershipsId","in":"body","required":true,"schema":{"$ref":"#/definitions/putMembershipsId"}}],"responses":{"200":{"description":"Update a membership"}},"tags":["memberships"],"operationId":"putMembershipsId"},"delete":{"summary":"Delete a membership","description":"Delete a membership","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a membership"}},"tags":["memberships"],"operationId":"deleteMembershipsId"}},"/users":{"get":{"summary":"List users","description":"List users","produces":["application/json"],"responses":{"200":{"description":"List users"}},"tags":["users"],"operationId":"getUsers"}},"/users/unique":{"get":{"summary":"List unique users","description":"List unique users","produces":["application/json"],"responses":{"200":{"description":"List unique users"}},"tags":["users"],"operationId":"getUsersUnique"}},"/assignments":{"get":{"summary":"List assignments","description":"List assignments","produces":["application/json"],"parameters":[{"in":"query","name":"status","type":"string","required":false}],"responses":{"200":{"description":"List assignments"}},"tags":["assignments"],"operationId":"getAssignments"}},"/hooks/unsubscribe":{"post":{"summary":"Delete a hook","description":"Delete a hook","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postHooksUnsubscribe","in":"body","required":true,"schema":{"$ref":"#/definitions/postHooksUnsubscribe"}}],"responses":{"201":{"description":"Delete a hook"}},"tags":["hooks"],"operationId":"postHooksUnsubscribe"}},"/hooks":{"post":{"summary":"Create a hook","description":"Create a hook","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postHooks","in":"body","required":true,"schema":{"$ref":"#/definitions/postHooks"}}],"responses":{"201":{"description":"Create a hook"}},"tags":["hooks"],"operationId":"postHooks"}},"/zapier_polling":{"get":{"summary":"Zapier polling sample payload","description":"Zapier polling sample payload","produces":["application/json"],"responses":{"200":{"description":"Zapier polling sample payload"}},"tags":["zapier_polling"],"operationId":"getZapierPolling"}}},"definitions":{"postChecklists":{"type":"object","properties":{"title":{"type":"string","description":"Run Title"},"business_days":{"type":"array","items":{"type":"string"}},"channel":{"type":"string"},"description":{"type":"string","description":"Run Description"},"expected_duration":{"type":"integer","format":"int32"},"expected_duration_units":{"type":"string"},"external_id":{"type":"string","description":"External ID"},"hide_steps_from_external":{"type":"boolean","default":false},"tag_list":{"type":"array","items":{"type":"string"}},"steps":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Step Title"},"header_step":{"type":"boolean","description":"Is Header Step?","default":false},"position":{"type":"integer","format":"int32","description":"Step Position"}},"required":["title"]}}},"required":["title"],"description":"Create Workflow"},"postChecklistsImport":{"type":"object","properties":{"department_id":{"type":"integer","format":"int32","description":"Department ID"},"json":{"type":"string","description":"JSON"}},"required":["department_id","json"],"description":"Import a checklist from a JSON"},"putChecklistsId":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"expected_duration":{"type":"integer","format":"int32"},"expected_duration_units":{"type":"string"},"tag_list":{"type":"array","items":{"type":"string"}},"hide_steps_from_external":{"type":"boolean"},"business_days":{"type":"array","items":{"type":"string"}}},"description":"Update a workflow"},"postChecklistsIdSteps":{"type":"object","properties":{"title":{"type":"string","description":"Step Title"},"header_step":{"type":"boolean","description":"Is Header Step?","default":false},"parent_step_id":{"type":"integer","format":"int32","description":"Parent Step ID","default":null},"position":{"type":"integer","format":"int32","description":"Step Position"}},"description":"Create a Workflow Step"},"postChecklistsIdHooksUnsubscribe":{"type":"object","properties":{"target_url":{"type":"string","description":"Target URL for Web Hook"},"event":{"type":"string","description":"Event for Web Hook"}},"description":"Delete a hook"},"postChecklistsIdHooks":{"type":"object","properties":{"target_url":{"type":"string","description":"Target URL for Web Hook"},"event":{"type":"string","description":"Event for Web Hook"}},"description":"Create a hook"},"putChecklistsIdStepsStepId":{"type":"object","properties":{"title":{"type":"string","description":"Step Title"},"header_step":{"type":"boolean","description":"Is Header Step?","default":false},"parent_step_id":{"type":"integer","format":"int32","description":"Parent Step ID","default":null},"position":{"type":"integer","format":"int32","description":"Step Position"}},"description":"Update a Workflow Step"},"postChecklistsIdStepsStepIdContentObjects":{"type":"object","properties":{"content":{"type":"string"},"position":{"type":"integer","format":"int32"},"caption":{"type":"string"},"content_type":{"type":"string"}},"required":["content_type"],"description":"Create a Content Object"},"putChecklistsIdStepsStepIdContentObjectsContentObjectId":{"type":"object","properties":{"content":{"type":"string"},"position":{"type":"integer","format":"int32"},"caption":{"type":"string"},"content_type":{"type":"string"}},"required":["content_type"],"description":"Update Content Object"},"postChecklistsIdStepsStepIdHooksUnsubscribe":{"type":"object","properties":{"event":{"type":"string"},"target_url":{"type":"string"}},"description":"Delete a hook"},"postChecklistsIdStepsStepIdHooks":{"type":"object","properties":{"event":{"type":"string"},"target_url":{"type":"string"}},"description":"Create a hook"},"putChecklistsIdStepsStepIdDataSetting":{"type":"object","properties":{"value_format":{"type":"string","description":"Data format (text, paragraph, date, datetime, email, phone, list, number, file, image, signature, url, choose_from_data_table)"},"label":{"type":"string","description":"Label for the data (max 75 chars)"},"required":{"type":"boolean","description":"Whether data is required","default":false},"values":{"type":"array","description":"List of choices (for list type only)","items":{"type":"string"}},"value_selection_type":{"type":"string","description":"Selection type: single or multi (for list type only)"},"data_table_id":{"type":"integer","format":"int32","description":"Data Table ID (for choose_from_data_table type only)"},"display_column_id":{"type":"integer","format":"int32","description":"Display Column ID (for choose_from_data_table type only)"},"number_min":{"type":"number","format":"float","description":"Minimum allowed value (for number type only)"},"number_max":{"type":"number","format":"float","description":"Maximum allowed value (for number type only)"},"max_decimal_places":{"type":"integer","format":"int32","description":"Maximum decimal places (for number type only)"},"allow_negative":{"type":"boolean","description":"Whether negative values are allowed (for number type only); defaults to true"}},"required":["value_format"],"description":"Create or update data setting for step"},"postChecklistsIdStepsStepIdDataSettings":{"type":"object","properties":{"value_format":{"type":"string","description":"Data format (text, paragraph, date, datetime, email, phone, list, number, file, image, signature, url, choose_from_data_table)"},"label":{"type":"string","description":"Label for the data (max 75 chars)"},"required":{"type":"boolean","description":"Whether data is required","default":false},"values":{"type":"array","description":"List of choices (for list type only)","items":{"type":"string"}},"value_selection_type":{"type":"string","description":"Selection type: single or multi (for list type only)"},"data_table_id":{"type":"integer","format":"int32","description":"Data Table ID (for choose_from_data_table type only)"},"display_column_id":{"type":"integer","format":"int32","description":"Display Column ID (for choose_from_data_table type only)"},"number_min":{"type":"number","format":"float","description":"Minimum allowed value (for number type only)"},"number_max":{"type":"number","format":"float","description":"Maximum allowed value (for number type only)"},"max_decimal_places":{"type":"integer","format":"int32","description":"Maximum decimal places (for number type only)"},"allow_negative":{"type":"boolean","description":"Whether negative values are allowed (for number type only); defaults to true"}},"required":["value_format"],"description":"Add a data setting to step"},"putChecklistsIdStepsStepIdDataSettingsDataSettingId":{"type":"object","properties":{"value_format":{"type":"string","description":"Data format"},"label":{"type":"string","description":"Label for the data (max 75 chars)"},"required":{"type":"boolean","description":"Whether data is required"},"values":{"type":"array","description":"List of choices (for list type only)","items":{"type":"string"}},"value_selection_type":{"type":"string","description":"Selection type: single or multi (for list type only)"},"data_table_id":{"type":"integer","format":"int32","description":"Data Table ID (for choose_from_data_table type only)"},"display_column_id":{"type":"integer","format":"int32","description":"Display Column ID (for choose_from_data_table type only)"},"number_min":{"type":"number","format":"float","description":"Minimum allowed value (for number type only)"},"number_max":{"type":"number","format":"float","description":"Maximum allowed value (for number type only)"},"max_decimal_places":{"type":"integer","format":"int32","description":"Maximum decimal places (for number type only)"},"allow_negative":{"type":"boolean","description":"Whether negative values are allowed (for number type only); defaults to true"}},"required":["value_format"],"description":"Update a data setting"},"postNotifications":{"type":"object","properties":{"notifications":{"type":"object"}},"required":["notifications"],"description":"Notification Settings"},"postDepartments":{"type":"object","properties":{"name":{"type":"string"},"signup_message":{"type":"string"},"time_zone_name":{"type":"string"},"generate_invitation_url":{"type":"boolean"}},"required":["name"],"description":"Create a department"},"putDepartmentsId":{"type":"object","properties":{"name":{"type":"string"},"signup_message":{"type":"string"},"time_zone_name":{"type":"string"},"regenerate_invitation_url":{"type":"boolean"}},"description":"Update a department"},"postRuns":{"type":"object","properties":{"checklist_id":{"type":"integer","format":"int32"},"channel":{"type":"string"},"external_id":{"type":"string"},"title":{"type":"string"},"users":{"type":"string"},"origin":{"type":"string"},"late_at":{"type":"string"},"started_at":{"type":"string"},"tag_list":{"type":"array","items":{"type":"string"}},"notes":{"type":"string"},"roles_to_users":{"type":"object"},"data_choices":{"type":"object"}},"required":["checklist_id"],"description":"Create a run"},"postRunsRunId":{"type":"object","properties":{"run":{"type":"object","properties":{"title":{"type":"string"},"external_id":{"type":"string"},"channel":{"type":"string"},"users":{"type":"string"},"origin":{"type":"string"},"tag_list":{"type":"array","items":{"type":"string"}},"late_at":{"type":"string"},"notes":{"type":"string"}}}},"description":"Update run"},"postRunsRunIdRunStepsIdAssign":{"type":"object","properties":{"assignee_id":{"type":"integer","format":"int32"}},"description":"Assign run step"},"postRunsRunIdRunStepsIdData":{"type":"object","properties":{"data":{"type":"string"},"data_upload_content_type":{"type":"string"},"data_upload_original_filename":{"type":"string"},"data_upload_file_size":{"type":"integer","format":"int32"}},"description":"Save data for a run step"},"putRunsRunIdRunStepsIdDataSettingsDataSettingId":{"type":"object","properties":{"value":{"type":"string","description":"Data value"}},"description":"Save data for a specific data setting"},"postMemberships":{"type":"object","properties":{"email":{"type":"string"},"role":{"type":"string"},"department_id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"required":["email","role"],"description":"Create membership"},"putMembershipsId":{"type":"object","properties":{"role":{"type":"string"},"username":{"type":"string"}},"required":["role","username"],"description":"Update a membership"},"postHooksUnsubscribe":{"type":"object","properties":{"target_url":{"type":"string"}},"required":["target_url"],"description":"Delete a hook"},"postHooks":{"type":"object","properties":{"event":{"type":"string"},"checklist_id":{"type":"integer","format":"int32"},"step_id":{"type":"string"},"target_url":{"type":"string"}},"required":["target_url"],"description":"Create a hook"}}}