{"_id":"59de6011debd1200240f6921","version":{"_id":"59de6011debd1200240f68ee","__v":2,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"parentDoc":null,"category":{"_id":"59de6011debd1200240f68f7","version":"59de6011debd1200240f68ee","project":"59de6011debd1200240f68ec","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-22T18:56:04.107Z","from_sync":false,"order":7,"slug":"positions-and-stages","title":"Positions and Stages"},"project":"59de6011debd1200240f68ec","__v":0,"user":"547504ed59fade080004cb8b","githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-22T21:04:10.562Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","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}","name":""},{"status":401,"language":"json","code":"{\n  \"message\": \"Authentication is required\"\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"curl -X GET -d 'api_token=secret-api-token' 'https://www.onboardiq.com/api/v2/funnels/11111111-0000-0000-0000-000000000000/stages'\n\n","language":"curl"},{"code":"https://www.onboardiq.com/api/v2/funnels/11111111-0000-0000-0000-000000000000/stages?api_token=secret-api-token\n\n","language":"text"}]},"method":"get","auth":"required","params":[{"_id":"56cb77cac675f50b00a4b7ae","ref":"","in":"path","required":false,"desc":"funnel_id must be passed in as a URL parameter","default":"11111111-0000-0000-0000-000000000000","type":"string","name":"funnel_id"},{"_id":"56cb77cac675f50b00a4b7ad","ref":"","in":"query","required":false,"desc":"api-token is required if not passed in through header","default":"secret-api-token","type":"string","name":"api_token"}],"url":"/funnels/:funnel_id/stages"},"isReference":false,"order":2,"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]","excerpt":"","slug":"list-all-stages","type":"endpoint","title":"List All Stages"}