{"_id":"59de6011debd1200240f6925","__v":6,"project":"59de6011debd1200240f68ec","parentDoc":null,"user":"547504ed59fade080004cb8b","version":{"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z","categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"59de6011debd1200240f68fe","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-29T17:56:09.833Z","from_sync":false,"order":9,"slug":"worker-management","title":"Worker Management"},"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-29T23:01:53.932Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X GET -d 'is_active=false&api_token=secret-api-token&funnel_id=11111111-0000-0000-0000-000000000000' 'https://api.fountain.com/v2/workers'\n\n","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"workers\": [\n    {\n      \"is_active\": true,\n      \"name\": \"Correct\",\n      \"email\": \"paris.johnston:::at:::shields.biz\",\n      \"id\": \"fe79660a-9678-4772-bbd5-da14289691b5\",\n      \"approved_at\": \"2018-03-15T16:12:03.701-07:00\",\n      \"data_collection_checks\": []\n    }\n  ],\n  \"pagination\": {\n    \"first\": 1,\n    \"previous\": \"\",\n    \"current\": 1,\n    \"next\": \"\",\n    \"last\": 1\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"579be2b81ea3140e0083b661","ref":"","in":"query","required":false,"desc":"Required if api_token is not passed in header","default":"secret-api-token","type":"string","name":"api_token"}],"url":"/workers/"},"isReference":false,"order":0,"body":"List all workers within your account. Pagination is available.\n\nUse the page parameter to indicate the page for pagination, e.g. &page=2 to get to the 2nd page of the listing.\n\nYou can also filter the workers by a funnel and/or active status, using funnel_id or is_active parameters. Note that you need a unique identifier of a funnel, not its title (this prevents any unfortunate mistakes that can be a result of renaming). To look up the ID of a funnel, use the List funnels method\n\n## Response Schema\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"-   additionalProperties: false\\n-   [workers](#workers-0-3816137456421094349)\\n    \\n    -   Required: no\\n    -   Type: array\\n    -   Items\\n        \\n        -   Required: no\\n        -   additionalProperties: false\\n        -   [is_active](#is_active-2--1978282199871381085)\\n            \\n            -   Required: no\\n            -   Type: boolean\\n            -   Example: true\\n            \\n        -   [name](#name-2--2558675228854589731)\\n            \\n            -   Required: no\\n            -   Type: string\\n            -   Example: \\\"Correct\\\"\\n            \\n        -   [email](#email-2-1945544459974371448)\\n            \\n            -   Required: no\\n            -   Type: string\\n            -   Example: \\\"paris.johnston@shields.biz\\\"\\n            \\n        -   [id](#id-2-2004418521970662945)\\n            \\n            -   Required: no\\n            -   Type: string\\n            -   Example: \\\"fe79660a-9678-4772-bbd5-da14289691b5\\\"\\n            \\n        -   [approved_at](#approved_at-2--4572481966606035672)\\n            \\n            -   Required: no\\n            -   Type: string\\n            -   Format: date-time\\n            -   Example: \\\"2018-03-15T16:12:03.701-07:00\\\"\\n            \\n        -   [data\\\\_collection\\\\_checks](#data_collection_checks-2-2066867576566146844)\\n            \\n            -   Required: no\\n            -   Type: array\\n            \\n        \\n    \\n-   [pagination](#pagination-0-54981042436236253)\\n    \\n    -   Required: no\\n    -   additionalProperties: false\\n    -   [first](#first-1--1856815114523554976)\\n        \\n        -   Required: no\\n        -   Type: integer\\n        -   Example: 1\\n        \\n    -   [previous](#previous-1--4360276479712952389)\\n        \\n        -   Required: no\\n        -   Type: null\\n        -   Example: \\\"\\\"\\n        \\n    -   [current](#current-1-3478434336654943128)\\n        \\n        -   Required: no\\n        -   Type: integer\\n        -   Example: 1\\n        \\n    -   [next](#next-1--2592809224026419461)\\n        \\n        -   Required: no\\n        -   Type: null\\n        -   Example: \\\"\\\"\\n        \\n    -   [last](#last-1-1263460097670529375)\\n        \\n        -   Required: no\\n        -   Type: integer\\n        -   Example: 1\",\n      \"language\": \"markdown\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"list-workers","type":"endpoint","title":"List Workers"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

api_token:
stringsecret-api-token
Required if api_token is not passed in header

Examples


Result Format


Documentation

List all workers within your account. Pagination is available. Use the page parameter to indicate the page for pagination, e.g. &page=2 to get to the 2nd page of the listing. You can also filter the workers by a funnel and/or active status, using funnel_id or is_active parameters. Note that you need a unique identifier of a funnel, not its title (this prevents any unfortunate mistakes that can be a result of renaming). To look up the ID of a funnel, use the List funnels method ## Response Schema [block:code] { "codes": [ { "code": "- additionalProperties: false\n- [workers](#workers-0-3816137456421094349)\n \n - Required: no\n - Type: array\n - Items\n \n - Required: no\n - additionalProperties: false\n - [is_active](#is_active-2--1978282199871381085)\n \n - Required: no\n - Type: boolean\n - Example: true\n \n - [name](#name-2--2558675228854589731)\n \n - Required: no\n - Type: string\n - Example: \"Correct\"\n \n - [email](#email-2-1945544459974371448)\n \n - Required: no\n - Type: string\n - Example: \"paris.johnston@shields.biz\"\n \n - [id](#id-2-2004418521970662945)\n \n - Required: no\n - Type: string\n - Example: \"fe79660a-9678-4772-bbd5-da14289691b5\"\n \n - [approved_at](#approved_at-2--4572481966606035672)\n \n - Required: no\n - Type: string\n - Format: date-time\n - Example: \"2018-03-15T16:12:03.701-07:00\"\n \n - [data\\_collection\\_checks](#data_collection_checks-2-2066867576566146844)\n \n - Required: no\n - Type: array\n \n \n \n- [pagination](#pagination-0-54981042436236253)\n \n - Required: no\n - additionalProperties: false\n - [first](#first-1--1856815114523554976)\n \n - Required: no\n - Type: integer\n - Example: 1\n \n - [previous](#previous-1--4360276479712952389)\n \n - Required: no\n - Type: null\n - Example: \"\"\n \n - [current](#current-1-3478434336654943128)\n \n - Required: no\n - Type: integer\n - Example: 1\n \n - [next](#next-1--2592809224026419461)\n \n - Required: no\n - Type: null\n - Example: \"\"\n \n - [last](#last-1-1263460097670529375)\n \n - Required: no\n - Type: integer\n - Example: 1", "language": "markdown" } ] } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}