{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants/:applicant_id/labels","auth":"required","results":{"codes":[{"name":"","code":"{\n \"labels\": [\n {\n \"title\": \"Label 0\",\n \"completed\": true\n }\n ]\n}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"Authentication is required\"\n}","language":"json","status":401}]},"settings":"","examples":{"codes":[{"code":"curl -X GET -H 'X-ACCESS-TOKEN: secret-api-token' 'https://api.fountain.com/v2/applicants/22222222-0000-0000-0000-000000000000/labels'","language":"curl"}]},"method":"get","params":[{"name":"applicant_id","type":"string","default":"22222222-0000-0000-0000-000000000000","desc":"ID of the applicant","required":false,"in":"path","ref":"","_id":"56ca9a4a0329540b0077f461"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"60db953a8cee24002a603a8f"}]},"next":{"description":"","pages":[]},"title":"List Labels for Applicant","type":"endpoint","slug":"testinput-1","excerpt":"","body":"This lists all labels for an applicant.\n\nThis way you can perform a quick check to see if the applicant has one label or another.\n\nYou can assign them a new label or remove an existing one using the corresponding API methods [PUT request](https://fountain.readme.io/v2.0/docs/update-label-for-applicant)\n\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"NOTE: URL Encoding Matters!\",\n \"body\": \"The label names that you use in other methods must be URL encoded, e.g. 'New%20label' and not 'New label'.\"\n}\n[/block]\n## Response Schema\n\n\n[block:html]\n{\n \"html\": \"<ul><li>additionalProperties: false</li><li> <span id=\\\"labels-0-3284962714596379388\\\">\\n <a href=\\\"#labels-0-3284962714596379388\\\" 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-1483506278322941128\\\">\\n <a href=\\\"#title-2-1483506278322941128\\\" 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-1337381411895595120\\\">\\n <a href=\\\"#completed-2-1337381411895595120\\\" class=\\\"anchor\\\">\\n <tt>completed</tt>\\n </a>\\n </span>\\n<div class=\\\"schema\\\"><ul><li>Required: no</li><li>Type: boolean</li><li>Example: <tt>true</tt></li></ul></div></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":"59de6011debd1200240f6934","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"},"user":"547504ed59fade080004cb8b","__v":8,"parentDoc":null,"project":"59de6011debd1200240f68ec","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Label Management","slug":"label-management-endpoints","order":3,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68fc","__v":0,"version":"59de6011debd1200240f68ee","project":"59de6011debd1200240f68ec","createdAt":"2016-02-22T04:45:31.980Z"},"createdAt":"2016-02-22T05:19:06.219Z","githubsync":""}
getList Labels for Applicant
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
applicant_id:
string22222222-0000-0000-0000-000000000000
ID of the applicant
Headers
X-ACCESS-TOKEN:
required
stringsecret-api-token
Access Token