{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants/:applicant_id/notes","auth":"required","results":{"codes":[{"name":"","code":"{\n  \"notes\": [\n    {\n      \"id\": \"8f247b3a-a473-4dfd-81cc-46fb527a8823\",\n      \"content\": \"note content\",\n      \"created_at\": \"2017-12-12T14:25:07.734-08:00\",\n      \"updated_at\": \"2017-12-12T14:25:07.734-08:00\",\n      \"user\": {\n        \"name\": \"Jane Smith\",\n        \"email\": \"jane:::at:::example.com\",\n        \"id\": \"b32b08ce-4a32-4de7-983a-7e2e521405a2\"\n      }\n    }\n  ]\n}","language":"json","status":200}]},"settings":"","params":[{"name":"applicant_id","type":"string","default":"22222222-0000-0000-0000-000000000000","desc":"Applicant ID","required":true,"in":"path","ref":"","_id":"5a8bff26c4fa5b0049f34f88"},{"name":"api_token","type":"string","default":"secret-api-key","desc":"API Token (not required if api_token is passed in by header)","required":true,"in":"query","ref":"","_id":"5a8bff26c4fa5b0049f34f87"}],"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/notes'"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"List Notes for Applicant","type":"endpoint","slug":"list-notes-for-applicant","excerpt":"","body":"List all notes associated with an applicant.\n\n## Response Schema\n\n*   notes\n    *   Required: yes\n    *   Type: array\n    *   Items\n        *   Required: no\n        *   id\n            *   Required: yes\n            *   Type: string\n            *   Example: \"8f247b3a-a473-4dfd-81cc-46fb527a8823\"\n        *   content\n            *   Required: yes\n            *   Type: string\n            *   Example: \"Good candidate\"\n        *   created_at\n            *   Required: yes\n            *   Type: string\n            *   Format: date-time\n            *   Example: \"2017-12-12T14:25:07.734-08:00\"\n        *   updated_at\n            *   Required: yes\n            *   Type: string\n            *   Format: date-time\n            *   Example: \"2017-12-12T14:25:07.734-08:00\"\n        *   user\n            *   Required: yes\n            *   additionalProperties: false\n            *   name\n                *   Required: yes\n                *   Type: string\n                *   Example: \"Ms. Tiana Hermiston\"\n            *   email\n                *   Required: yes\n                *   Type: string\n                *   Example: \"[email protected]\"\n            *   id\n                *   Required: yes\n                *   Type: string\n                *   Example: \"b32b08ce-4a32-4de7-983a-7e2e521405a2\"","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a8bfda8c4fa5b0049f34f52","project":"59de6011debd1200240f68ec","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"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Notes Management","slug":"notes-management","order":4,"from_sync":false,"reference":false,"_id":"5a8bfcf2e86f530012159bb2","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","createdAt":"2018-02-20T10:48:18.428Z","__v":0},"user":"547504ed59fade080004cb8b","createdAt":"2018-02-20T10:51:20.500Z","githubsync":"","__v":12,"parentDoc":null}

getList Notes for Applicant


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

applicant_id:
required
string22222222-0000-0000-0000-000000000000
Applicant ID

Query Params

api_token:
required
stringsecret-api-key
API Token (not required if api_token is passed in by header)

Examples


Result Format


Documentation

List all notes associated with an applicant. ## Response Schema * notes * Required: yes * Type: array * Items * Required: no * id * Required: yes * Type: string * Example: "8f247b3a-a473-4dfd-81cc-46fb527a8823" * content * Required: yes * Type: string * Example: "Good candidate" * created_at * Required: yes * Type: string * Format: date-time * Example: "2017-12-12T14:25:07.734-08:00" * updated_at * Required: yes * Type: string * Format: date-time * Example: "2017-12-12T14:25:07.734-08:00" * user * Required: yes * additionalProperties: false * name * Required: yes * Type: string * Example: "Ms. Tiana Hermiston" * email * Required: yes * Type: string * Example: "[email protected]" * id * Required: yes * Type: string * Example: "b32b08ce-4a32-4de7-983a-7e2e521405a2"

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