{"_id":"59de6011debd1200240f6934","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"},"user":"547504ed59fade080004cb8b","__v":3,"parentDoc":null,"project":"59de6011debd1200240f68ec","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"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-22T05:19:06.219Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"labels\": [\n    {\n      \"title\": \"Label 0\",\n      \"completed\": true\n    }\n  ]\n}","name":""},{"status":401,"language":"json","code":"{\n  \"message\": \"Authentication is required\"\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X GET -d 'api_token=secret-api-token' 'https://api.fountain.com/v2/applicants/22222222-0000-0000-0000-000000000000/labels'"}]},"method":"get","auth":"required","params":[{"_id":"56ca9a4a0329540b0077f461","ref":"","in":"path","required":false,"desc":"ID of the applicant","default":"22222222-0000-0000-0000-000000000000","type":"string","name":"applicant_id"},{"_id":"56ca9a4a0329540b0077f460","ref":"","in":"query","required":false,"desc":"required if api_token is not passed in by header","default":"secret-api-key","type":"string","name":"api_token"}],"url":"/applicants/:applicant_id/labels"},"isReference":false,"order":0,"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]","excerpt":"","slug":"testinput-1","type":"endpoint","title":"List Labels for Applicant"}

getList Labels for Applicant


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

applicant_id:
string22222222-0000-0000-0000-000000000000
ID of the applicant

Query Params

api_token:
stringsecret-api-key
required if api_token is not passed in by header

Examples


Result Format


Documentation

This lists all labels for an applicant. This way you can perform a quick check to see if the applicant has one label or another. You 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) [block:callout] { "type": "warning", "title": "NOTE: URL Encoding Matters!", "body": "The label names that you use in other methods must be URL encoded, e.g. 'New%20label' and not 'New label'." } [/block] ## Response Schema [block:html] { "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>" } [/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 }}