{"_id":"5d4b3eed6931b30037a6ad62","project":"59de6011debd1200240f68ec","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":"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"},"user":"547504ed59fade080004cb8b","__v":2,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-08-07T21:13:17.614Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X GET -d 'api_token=secret-api-token' 'https://www.onboardiq.com/api/v2/funnels/d91b5774-f62f-40ae-b4f1-15c0c1d2b861'","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"name":"","code":"{\n  \"title\": \"Internal Creative Representative\",\n  \"address\": \"\",\n  \"time_zone\": \"UTC\",\n  \"description\": \"\",\n  \"requirements\": \"\",\n  \"fields\": [],\n  \"is_private\": false,\n  \"active\": true,\n  \"custom_id\": \"31337-31338-31339\",\n  \"id\": \"d91b5774-f62f-40ae-b4f1-15c0c1d2b861\",\n  \"stages\": [\n    {\n      \"title\": \"Approved\",\n      \"type\": \"HiredStage\",\n      \"id\": \"43f9c373-bde9-4b9a-84f6-2e3e6cb3d126\"\n    }\n  ],\n  \"location\": {\n    \"id\": \"7f88228c-cba9-4827-b71d-e81244c05d37\",\n    \"name\": \"San Francisco\"\n  }\n}","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"579be22b5623be2200832673","ref":"","in":"path","required":false,"desc":"ID must be included in the URL","default":"550e8400-e29b-41d4-a716-446655440000","type":"string","name":"id"},{"_id":"579be22b5623be2200832672","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":"/funnels/:id"},"isReference":false,"order":999,"body":"## Get Opening","excerpt":"","slug":"get-opening","type":"endpoint","title":"Get Opening"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string550e8400-e29b-41d4-a716-446655440000
ID must be included in the URL

Query Params

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

Examples


Result Format


Documentation

## Get Opening

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 }}