Work is an *integration* unit, typically for imports and exports.
Most run continually, while some run to completion.
You generally would only use it through the Webadmin Integrations.
* *Workflow* A specific type of integration is a Workflow, must belong to a *Provider*
* *Provider* A company that provides api's. Facebook, Google Analytics, Marketo, etc.
* *Auth* An authentication/authorization for a provider to allow *work* to run.
* *Work* A single running instance of a workflow for an account.
" url: "https://www.contentstack.com/docs/developers/apis/lytics-api/v1/work" product: "Contentstack" doc_type: "guide" audience: - developers - admins version: "current" last_updated: "2026-11-05" --- # Work Work is an \*integration\* unit, typically for imports and exports. Most run continually, while some run to completion. You generally would only use it through the Webadmin Integrations. \* \*Workflow\* A specific type of integration is a Workflow, must belong to a \*Provider\* \* \*Provider\* A company that provides api's. Facebook, Google Analytics, Marketo, etc. \* \*Auth\* An authentication/authorization for a provider to allow \*work\* to run. \* \*Work\* A single running instance of a workflow for an account. ## Work List ### Work List **GET** `/api/work` Get list of all running integrations (work) for this account. #### Query Parameters - **account_id** (optional) Your Lytics account ID. - **showhidden** (optional) True/False show all hidden work items - **state** (optional) True/False show all state - **showcompleted** (optional) True/False show all completed work items - **showdeleted** (optional) True/False show all deleted work items (works that was deleted using work/{id}/delete command) #### Headers - **Authorization** (optional) #### Sample Response ```json { "data": [ { "account_id": "4f7b525bdba058fc096757a6", "aid": 12, "config": { "delimiter": null, "email_to": "fake@gmail.com", "fields": [], "limit": null, "segment_id": "d5975ab901f7f660845c95ee6aa3cadd", "table": "user", "write_headers": true }, "hidden": false, "id": "ca756c13469228b723652f1e5168650f", "created": "2014-08-04T21:18:20.124Z", "updated": "2014-08-04T21:18:20.124Z", "runtime": "", "statuscode": "completed", "deleted": false, "tag": "", "user_id": "50f4c7c6e327a73ae8000004", "work_state_version": 0, "workflow": "lytics_simple_csv_export", "workflow_id": "75ce615fdfa048b7a5d5ea41fe7c1260" } ] } ``` ## Work Create ### Work Create **POST** `/api/work` There are a list of available work-types in the workflow api. To create a work unit, there is a \*config\* block with the work configuration settings, with the fields listed in the workflow. \`\`sh curl -s -H "Authorization: $LIOKEY" \\ \-XPOST "https://api.lytics.io/api/work" -d ' { "workflow\_id":"eventscopy" , "name":"Ecommerce Demo Copy" , "config":{ "destination\_aid": "2223" } } ' | jq '.' \`\` #### Query Parameters - **account_id** (optional) Your Lytics account ID. #### Headers - **Authorization** (optional) #### Sample Response ```json { "data": { "account_id": "4f7b525bdba058fc096757a6", "aid": 12, "config": { "delimiter": null, "email_to": "fake@gmail.com", "fields": [], "limit": null, "segment_id": "d5975ab901f7f660845c95ee6aa3cadd", "table": "user", "write_headers": true }, "state": {}, "statuscode": "completed", "hidden": false, "id": "ca756c13469228b723652f1e5168650f", "created": "2014-08-04T21:18:20.124Z", "updated": "2014-08-04T21:18:20.124Z", "runtime": "", "deleted": false, "tag": "", "user_id": "50f4c7c6e327a73ae8000004", "work_state_version": 0, "workflow": "lytics_simple_csv_export", "workflow_id": "75ce615fdfa048b7a5d5ea41fe7c1260" } } ``` ## Work Fetch ### Work Fetch **GET** `/api/work/{id}` Get single work resource #### URL Parameters - **id** (required) id of work #### Query Parameters - **account_id** (optional) Your Lytics account ID. #### Headers - **Authorization** (optional) #### Sample Response ```json { "data": { "account_id": "4f7b525bdba058fc096757a6", "aid": 12, "config": { "delimiter": null, "email_to": "fake@gmail.com", "fields": [], "limit": null, "segment_id": "d5975ab901f7f660845c95ee6aa3cadd", "table": "user", "write_headers": true }, "state": {}, "statuscode": "completed", "hidden": false, "id": "ca756c13469228b723652f1e5168650f", "created": "2014-08-04T21:18:20.124Z", "updated": "2014-08-04T21:18:20.124Z", "runtime": "", "deleted": false, "tag": "", "user_id": "50f4c7c6e327a73ae8000004", "work_state_version": 0, "workflow": "lytics_simple_csv_export", "workflow_id": "75ce615fdfa048b7a5d5ea41fe7c1260" } } ``` ## Work Delete ### Work Delete **DELETE** `/api/work/{id}` #### URL Parameters - **id** (required) id of work #### Query Parameters - **account_id** (optional) Your Lytics account ID. #### Headers - **Authorization** (optional) #### Sample Response ```json No Content ``` ## Retrieve Work Status ### Retrieve Work Status **GET** `/api/work/_status` #### Query Parameters - **account_id** (optional) Your Lytics account ID. - **status** (optional) one of runnable, errorwait, paused, killed - **workflow_id** (optional) - **resume** (optional) True/False for resume this item as well - **acctid** (optional) #### Headers - **Authorization** (optional) #### Sample Response ```json { "data": { "account_id": "4f7b525bdba058fc096757a6", "aid": 12, "config": { "delimiter": null, "email_to": "fake@gmail.com", "fields": [], "limit": null, "segment_id": "d5975ab901f7f660845c95ee6aa3cadd", "table": "user", "write_headers": true }, "state": {}, "statuscode": "completed", "hidden": false, "id": "ca756c13469228b723652f1e5168650f", "created": "2014-08-04T21:18:20.124Z", "updated": "2014-08-04T21:18:20.124Z", "runtime": "", "deleted": false, "tag": "", "user_id": "50f4c7c6e327a73ae8000004", "work_state_version": 0, "workflow": "lytics_simple_csv_export", "workflow_id": "75ce615fdfa048b7a5d5ea41fe7c1260" } } ``` ## Work Command Post ### Work Command Post **POST** `/api/work/{id}/{cmd}` Send a work command #### URL Parameters - **id** (required) - **cmd** (required) #### Query Parameters - **account_id** (optional) Your Lytics account ID. - **for** (optional) #### Headers - **Authorization** (optional) #### Sample Response ```json { "data": { "account_id": "4f7b525bdba058fc096757a6", "aid": 12, "config": { "delimiter": null, "email_to": "fake@gmail.com", "fields": [], "limit": null, "segment_id": "d5975ab901f7f660845c95ee6aa3cadd", "table": "user", "write_headers": true }, "state": {}, "statuscode": "completed", "hidden": false, "id": "ca756c13469228b723652f1e5168650f", "created": "2014-08-04T21:18:20.124Z", "updated": "2014-08-04T21:18:20.124Z", "runtime": "", "deleted": false, "tag": "", "user_id": "50f4c7c6e327a73ae8000004", "work_state_version": 0, "workflow": "lytics_simple_csv_export", "workflow_id": "75ce615fdfa048b7a5d5ea41fe7c1260" } } ``` ## Work Bounce ### Work Bounce **POST** `/api/work/_bounceall` #### Query Parameters - **account_id** (optional) Your Lytics account ID. - **status** (optional) - **all_accounts** (optional) All accounts? - **cmd** (optional) #### Headers - **Authorization** (optional) #### Sample Response ```json { "data": { "account_id": "4f7b525bdba058fc096757a6", "aid": 12, "config": { "delimiter": null, "email_to": "fake@gmail.com", "fields": [], "limit": null, "segment_id": "d5975ab901f7f660845c95ee6aa3cadd", "table": "user", "write_headers": true }, "state": {}, "statuscode": "completed", "hidden": false, "id": "ca756c13469228b723652f1e5168650f", "created": "2014-08-04T21:18:20.124Z", "updated": "2014-08-04T21:18:20.124Z", "runtime": "", "deleted": false, "tag": "", "user_id": "50f4c7c6e327a73ae8000004", "work_state_version": 0, "workflow": "lytics_simple_csv_export", "workflow_id": "75ce615fdfa048b7a5d5ea41fe7c1260" } } ```