{"_id":"59de6011debd1200240f691c","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"},"__v":1,"category":{"_id":"59de6011debd1200240f68fc","__v":0,"version":"59de6011debd1200240f68ee","project":"59de6011debd1200240f68ec","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-22T04:45:31.980Z","from_sync":false,"order":3,"slug":"label-management-endpoints","title":"Label Management"},"user":"547504ed59fade080004cb8b","parentDoc":null,"project":"59de6011debd1200240f68ec","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-22T06:40:33.688Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X GET -d 'api_token=secret-api-token' 'https://api.fountain.com/v2/stages/11111111-0000-0000-0000-000000000000/labels'","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"labels\": [\n    {\n      \"title\": \"Label 0\",\n      \"completed\": 0\n    }\n  ]\n}"}]},"settings":"","auth":"required","params":[{"_id":"56caad615439cb0b00117982","ref":"","in":"path","required":false,"desc":"Stage of the workflow you wish to list labels for","default":"11111111-0000-0000-0000-000000000000","type":"string","name":"stage_id"},{"_id":"56caad615439cb0b00117981","ref":"","in":"query","required":false,"desc":"required if api-token is not included in header","default":"secret-api-token","type":"string","name":"api_token"}],"url":"/stages/:stage_id/labels"},"isReference":false,"order":2,"body":"This method lists all the labels that are available in a specific stage.\n\nYou can assign labels to applicants using the applicant label management methods in the API.\n\n## Response Schema\n[block:html]\n{\n  \"html\": \"<ul><li>additionalProperties: false</li><li>    <span id=\\\"labels-0--911160045465940392\\\">\\n      <a href=\\\"#labels-0--911160045465940392\\\" class=\\\"anchor\\\">\\n        <tt>labels</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=\\\"title-2--3414165642135670164\\\">\\n      <a href=\\\"#title-2--3414165642135670164\\\" 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>\\\"Label 0\\\"</tt></li></ul></div></li><li>    <span id=\\\"completed-2-3132101147321160944\\\">\\n      <a href=\\\"#completed-2-3132101147321160944\\\" class=\\\"anchor\\\">\\n        <tt>completed</tt>\\n      </a>\\n    </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: integer</li><li>Example: <tt>0</tt></li></ul></div></li></ul></div></li></ul></div></li></ul>\"\n}\n[/block]","excerpt":"","slug":"list-all-labels-in-stage","type":"endpoint","title":"List All Labels in Stage"}

getList All Labels in Stage


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

stage_id:
string11111111-0000-0000-0000-000000000000
Stage of the workflow you wish to list labels for

Query Params

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

Examples


Result Format


Documentation

This method lists all the labels that are available in a specific stage. You can assign labels to applicants using the applicant label management methods in the API. ## Response Schema [block:html] { "html": "<ul><li>additionalProperties: false</li><li> <span id=\"labels-0--911160045465940392\">\n <a href=\"#labels-0--911160045465940392\" class=\"anchor\">\n <tt>labels</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=\"title-2--3414165642135670164\">\n <a href=\"#title-2--3414165642135670164\" 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>\"Label 0\"</tt></li></ul></div></li><li> <span id=\"completed-2-3132101147321160944\">\n <a href=\"#completed-2-3132101147321160944\" class=\"anchor\">\n <tt>completed</tt>\n </a>\n </span>\n<div class=\"schema\"><ul><li>Required: no</li><li>Type: integer</li><li>Example: <tt>0</tt></li></ul></div></li></ul></div></li></ul></div></li></ul>" } [/block]

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