{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/funnels","auth":"required","settings":"","examples":{"codes":[{"code":"curl -X GET -d 'api_token=secret-api-token' 'https://www.onboardiq.com/api/v2/funnels'","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"funnels\": [\n    {\n      \"id\": \"49dbf2f3-057f-44b4-a638-8fac5aac2adf\",\n      \"custom_id\": \"3d67750a-dcf4-4ada-a3e4-ee44661949fc\",\n      \"title\": \"My Public Funnel\",\n      \"address\": \"5th Ave. 13\",\n      \"time_zone\": \"UTC\",\n      \"description\": \"This funnel is for anyone\",\n      \"requirements\": \"No need\",\n      \"fields\": [\n        {\n          \"question\": \"Foo\",\n          \"type\": \"text_field\",\n          \"key\": \"foo\"\n        }\n      ],\n      \"stages\": [\n        {\n          \"id\": \"70d446ca-670d-44be-a728-6c3d1921fb97\",\n          \"title\": \"Approved\",\n          \"type\": \"HiredStage\"\n        }\n      ],\n      \"is_private\": false,\n      \"active\": true,\n      \"location\": {\n        \"id\": \"7f88228c-cba9-4827-b71d-e81244c05d37\",\n        \"name\": \"San Francisco\"\n      }\n    }\n  ],\n  \"pagination\": {\n    \"first\": 1,\n    \"previous\": \"\",\n    \"current\": 1,\n    \"next\": \"\",\n    \"last\": 1\n  }\n}","name":""},{"status":401,"language":"json","code":"{\n  \"message\": \"Authentication is required\"\n}","name":""}]},"params":[{"name":"api_token","type":"string","default":"secret-api-token","desc":"required if api-token not passed in through header","required":false,"in":"query","ref":"","_id":"56cb70126b06f11d0040f0c3"}]},"next":{"description":"","pages":[]},"title":"List All Openings","type":"endpoint","slug":"list-all-positions","excerpt":"","body":"## List Openings (Funnels)\n\nList all Openings within your account. Funnel is used interchangeably with Opening. \n\nEach Opening contains information on address, stages for the funnel, location, active status, and other.Check the example to see what properties are 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\n\n\n\n\n\n[block:html]\n{\n  \"html\": \"<ul><li>additionalProperties: false</li><li>   <span id=\\\"funnels-0-3252968255463617634\\\">\\n      <a href=\\\"#funnels-0-3252968255463617634\\\" class=\\\"anchor\\\">\\n        <tt>funnels</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"id-2-3671915847291678636\\\">\\n      <a href=\\\"#id-2-3671915847291678636\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"49dbf2f3-057f-44b4-a638-8fac5aac2adf\\\"</tt></li></ul></div></li><li>    <span id=\\\"custom_id-2-1077755098682472790\\\">\\n      <a href=\\\"#custom_id-2-1077755098682472790\\\" class=\\\"anchor\\\">\\n        <tt>custom_id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"3d67750a-dcf4-4ada-a3e4-ee44661949fc\\\"</tt></li></ul></div></li><li>    <span id=\\\"title-2--1295624593669106898\\\">\\n      <a href=\\\"#title-2--1295624593669106898\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"My Public Funnel\\\"</tt></li></ul></div></li><li>    <span id=\\\"address-2--3577454550030215962\\\">\\n      <a href=\\\"#address-2--3577454550030215962\\\" class=\\\"anchor\\\">\\n        <tt>address</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"5th Ave. 13\\\"</tt></li></ul></div></li><li>    <span id=\\\"time_zone-2-3344876863017893471\\\">\\n      <a href=\\\"#time_zone-2-3344876863017893471\\\" class=\\\"anchor\\\">\\n        <tt>time_zone</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"UTC\\\"</tt></li></ul></div></li><li>    <span id=\\\"description-2-989581933641777207\\\">\\n      <a href=\\\"#description-2-989581933641777207\\\" class=\\\"anchor\\\">\\n        <tt>description</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"This funnel is for anyone\\\"</tt></li></ul></div></li><li>    <span id=\\\"requirements-2--1312584589803426353\\\">\\n      <a href=\\\"#requirements-2--1312584589803426353\\\" class=\\\"anchor\\\">\\n        <tt>requirements</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"No need\\\"</tt></li></ul></div></li><li>    <span id=\\\"fields-2-3642812021523764555\\\">\\n      <a href=\\\"#fields-2-3642812021523764555\\\" class=\\\"anchor\\\">\\n        <tt>fields</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"question-4--4220527171635911890\\\">\\n      <a href=\\\"#question-4--4220527171635911890\\\" class=\\\"anchor\\\">\\n        <tt>question</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"Foo\\\"</tt></li></ul></div></li><li>    <span id=\\\"type-4-2639950115749644647\\\">\\n      <a href=\\\"#type-4-2639950115749644647\\\" 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>\\\"text_field\\\"</tt></li></ul></div></li><li>    <span id=\\\"key-4-356642415492503519\\\">\\n      <a href=\\\"#key-4-356642415492503519\\\" class=\\\"anchor\\\">\\n        <tt>key</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: string</li><li>Example: <tt>\\\"foo\\\"</tt></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"stages-2--2669108567953813548\\\">\\n      <a href=\\\"#stages-2--2669108567953813548\\\" class=\\\"anchor\\\">\\n        <tt>stages</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: array</li><li>Items<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"id-4--4076530494843670402\\\">\\n      <a href=\\\"#id-4--4076530494843670402\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"70d446ca-670d-44be-a728-6c3d1921fb97\\\"</tt></li></ul></div></li><li>    <span id=\\\"title-4-1896356035772268468\\\">\\n      <a href=\\\"#title-4-1896356035772268468\\\" class=\\\"anchor\\\">\\n        <tt>title</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"Approved\\\"</tt></li></ul></div></li><li>    <span id=\\\"type-4--403558687928482356\\\">\\n      <a href=\\\"#type-4--403558687928482356\\\" class=\\\"anchor\\\">\\n        <tt>type</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"HiredStage\\\"</tt></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"is_private-2-606760019763311045\\\">\\n      <a href=\\\"#is_private-2-606760019763311045\\\" class=\\\"anchor\\\">\\n        <tt>is_private</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: boolean</li><li>Example: <tt>false</tt></li></ul></div></li><li>    <span id=\\\"active-2--1172918582256399859\\\">\\n      <a href=\\\"#active-2--1172918582256399859\\\" class=\\\"anchor\\\">\\n        <tt>active</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: boolean</li><li>Example: <tt>true</tt></li></ul></div></li><li>    <span id=\\\"location-2--3474240681022987062\\\">\\n      <a href=\\\"#location-2--3474240681022987062\\\" class=\\\"anchor\\\">\\n        <tt>location</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>additionalProperties: false</li><li>    <span id=\\\"id-3--3195387732426562960\\\">\\n      <a href=\\\"#id-3--3195387732426562960\\\" class=\\\"anchor\\\">\\n        <tt>id</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"7f88228c-cba9-4827-b71d-e81244c05d37\\\"</tt></li></ul></div></li><li>    <span id=\\\"name-3-1586330234531367428\\\">\\n      <a href=\\\"#name-3-1586330234531367428\\\" class=\\\"anchor\\\">\\n        <tt>name</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: string</li><li>Example: <tt>\\\"San Francisco\\\"</tt></li></ul></div></li></ul></div></li></ul></div></li></ul></div></li><li>    <span id=\\\"pagination-0-2595523042240698909\\\">\\n      <a href=\\\"#pagination-0-2595523042240698909\\\" class=\\\"anchor\\\">\\n        <tt>pagination</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>additionalProperties: false</li><li>    <span id=\\\"first-1-2946433588905895003\\\">\\n      <a href=\\\"#first-1-2946433588905895003\\\" class=\\\"anchor\\\">\\n        <tt>first</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: integer</li><li>Example: <tt>1</tt></li></ul></div></li><li>    <span id=\\\"previous-1-590223869613457971\\\">\\n      <a href=\\\"#previous-1-590223869613457971\\\" class=\\\"anchor\\\">\\n        <tt>previous</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: null</li><li>Example: <tt>\\\"\\\"</tt></li></ul></div></li><li>    <span id=\\\"current-1--1711027864452285973\\\">\\n      <a href=\\\"#current-1--1711027864452285973\\\" class=\\\"anchor\\\">\\n        <tt>current</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: integer</li><li>Example: <tt>1</tt></li></ul></div></li><li>    <span id=\\\"next-1--3488525031023634592\\\">\\n      <a href=\\\"#next-1--3488525031023634592\\\" class=\\\"anchor\\\">\\n        <tt>next</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: null</li><li>Example: <tt>\\\"\\\"</tt></li></ul></div></li><li>    <span id=\\\"last-1--3748188452111021612\\\">\\n      <a href=\\\"#last-1--3748188452111021612\\\" class=\\\"anchor\\\">\\n        <tt>last</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: yes</li><li>Type: integer</li><li>Example: <tt>1</tt></li></ul></div></li></ul></div></li></ul>\"\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59de6011debd1200240f691f","__v":8,"user":"547504ed59fade080004cb8b","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"},"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,"project":"59de6011debd1200240f68ec","createdAt":"2016-02-22T20:31:14.706Z","githubsync":""}