{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/funnels/:funnel_id/stages","auth":"required","results":{"codes":[{"name":"","code":"{\n  \"stages\": [\n    {\n      \"id\": \"70d446ca-670d-44be-a728-6c3d1921fb97\",\n      \"custom_id\": \"3d67750a-dcf4-4ada-a3e4-ee44661949fc\",\n      \"title\": \"Approved\",\n      \"type\": \"HiredStage\"\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{\n  \"message\": \"Authentication is required\"\n}","language":"json","status":401}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X GET -H 'X-ACCESS-TOKEN: secret-api-token' 'https://www.onboardiq.com/api/v2/funnels/11111111-0000-0000-0000-000000000000/stages'\n\n"},{"language":"text","code":"https://www.onboardiq.com/api/v2/funnels/11111111-0000-0000-0000-000000000000/stages?api_token=secret-api-token\n\n"}]},"method":"get","params":[{"name":"funnel_id","type":"string","default":"11111111-0000-0000-0000-000000000000","desc":"funnel_id must be passed in as a URL parameter","required":false,"in":"path","ref":"","_id":"56cb77cac675f50b00a4b7ae"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"60dcf05b2fa984003bd6ff17"}]},"next":{"description":"","pages":[]},"title":"List All Stages","type":"endpoint","slug":"list-all-stages","excerpt":"","body":"Lists all stages in the position (also known as funnels). This method returns all of funnel stages and their respective IDs as well.\n\nUse the supplied stage ID to reference a specific stage in other API methods, such as List applicants.\n\n## Response Schema\n[block:html]\n{\n  \"html\": \"<ul><li>additionalProperties: false</li><li>    <span id=\\\"stages-0-2285755920085873180\\\">\\n      <a href=\\\"#stages-0-2285755920085873180\\\" class=\\\"anchor\\\">\\n        <tt>stages</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"id-2-3753470454309739724\\\">\\n      <a href=\\\"#id-2-3753470454309739724\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"70d446ca-670d-44be-a728-6c3d1921fb97\\\"</tt></li></ul></div></li><li>    <span id=\\\"title-2--3082564288884435692\\\">\\n      <a href=\\\"#title-2--3082564288884435692\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"Approved\\\"</tt></li></ul></div></li><li>    <span id=\\\"type-2-2191766133828752412\\\">\\n      <a href=\\\"#type-2-2191766133828752412\\\" class=\\\"anchor\\\">\\n        <tt>type</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"HiredStage\\\"</tt></li></ul></div></li></ul></div></li></ul></div></li></ul>\"\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59de6011debd1200240f6921","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Openings and Stages","slug":"positions-and-stages","order":7,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68f7","version":"59de6011debd1200240f68ee","project":"59de6011debd1200240f68ec","__v":0,"createdAt":"2016-02-22T18:56:04.107Z"},"project":"59de6011debd1200240f68ec","__v":5,"user":"547504ed59fade080004cb8b","createdAt":"2016-02-22T21:04:10.562Z","githubsync":""}