{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/stages/:stage_id","auth":"required","results":{"codes":[{"name":"","code":"{\n  \"id\": \"70d446ca-670d-44be-a728-6c3d1921fb97\",\n  \"custom_id\": \"3d67750a-dcf4-4ada-a3e4-ee44661949fc\",\n  \"title\": \"Approved\",\n  \"type\": \"HiredStage\",\n  \"position\": \"4\",\n  \"num_applicants\": 3\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 -d 'api_token=secret-api-token' 'https://www.onboardiq.com/api/v2/stages/11111111-0000-0000-0000-000000000000'\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":"stage_id","type":"string","default":"11111111-0000-0000-0000-000000000000","desc":"stage_id must be passed in as a URL parameter","required":false,"in":"path","ref":"","_id":"56cb77cac675f50b00a4b7ae"},{"name":"api_token","type":"string","default":"secret-api-token","desc":"api-token is required if not passed in through header","required":false,"in":"query","ref":"","_id":"56cb77cac675f50b00a4b7ad"}]},"next":{"description":"","pages":[]},"title":"Get Stage","type":"endpoint","slug":"get-stage","excerpt":"","body":"This method returns basic information for the given stage.","updates":[],"order":999,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f8a28d3d917ba004e50aae8","createdAt":"2020-10-16T23:12:19.994Z","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"},"project":"59de6011debd1200240f68ec","__v":1}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

stage_id:
string11111111-0000-0000-0000-000000000000
stage_id must be passed in as a URL parameter

Query Params

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

Examples


Result Format


Documentation

This method returns basic information for the given stage.

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