{"_id":"59de6011debd1200240f691a","category":{"_id":"59de6011debd1200240f68fe","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-07-29T17:56:09.833Z","from_sync":false,"order":9,"slug":"worker-management","title":"Worker Management"},"project":"59de6011debd1200240f68ec","__v":24,"parentDoc":null,"user":"547504ed59fade080004cb8b","version":{"_id":"59de6011debd1200240f68ee","__v":2,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-29T23:05:53.079Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"is_active\": true,\n  \"name\": \"Ms. Isaiah Bernier\",\n  \"email\": \"dariana_stiedemann:::at:::streichfadel.co\",\n  \"id\": \"70bbb9f4-bb94-4dbd-a01c-3a2f9ef3098e\",\n  \"approved_at\": \"2018-05-24T03:31:07.626-07:00\",\n  \"data_collection_checks\": [\n    {\n      \"id\": \"a94329ff-47fc-4b9c-8e62-01e0f8e53c91\",\n      \"requested_at\": \"2018-05-14T03:31:08.216-07:00\",\n      \"uploaded_at\": \"2018-05-15T03:31:08.216-07:00\",\n      \"rejected_at\": \"2018-05-16T03:31:08.216-07:00\",\n      \"confirmed_at\": \"2018-05-17T03:31:08.217-07:00\",\n      \"canceled_at\": \"2018-05-19T03:31:08.217-07:00\",\n      \"status\": \"pending\",\n      \"confirmed_user\": \"Rosanna Boehm\",\n      \"rule\": {\n        \"id\": \"c5f481e2-519b-4570-8ad0-1ddb30214068\",\n        \"title\": \"Principal Accounts Architect\"\n      },\n      \"uploads\": [\n        {\n          \"created_at\": \"2018-05-24T03:31:08.504-07:00\",\n          \"structured_data\": {},\n          \"secure_data\": {},\n          \"data\": {},\n          \"files\": [\n            {\n              \"name\": \"global_research_analyst\",\n              \"friendly_name\": \"Global Research Analyst\",\n              \"filename\": \"avatar.jpg\",\n              \"size\": 99999,\n              \"id\": \"8ed6f1df-189e-4b81-b2d4-4edee787ec6e/c0ed8226-b812-4ce3-a4da-5e83b8a3731c/e964c508-48a8-4cfc-bfab-bfab8c55df81_avatar.jpg\",\n              \"public_url\": \"https://file.url\",\n              \"stage\": \"\"\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"curl -X GET -d 'api_token=secret-api-token' 'https://api.fountain.com/v2/workers/ad91e6da-51d7-4c53-b5eb-92350558a1be'\n\n","language":"curl"}]},"method":"get","auth":"required","params":[{"_id":"5b47a14d62169b0003a541c4","ref":"","in":"query","required":false,"desc":"Required if api_token is not passed in header","default":"secret-api-token","type":"string","name":"api_token"},{"_id":"5b47a226b1575600036e5f0b","ref":"","in":"path","required":false,"desc":"Worker ID (Required)","default":"550e8400-e29b-41d4-a716-446655440000","type":"string","name":"id"}],"url":"/workers/:id"},"isReference":false,"order":1,"body":"A standard GET call for worker info yields basic worker data, status and the last data collection checks collected and approved in posthire. Supply the worker id (same as applicant id) and Fountain will return the corresponding worker info.\n\nNote that data collected via a secure field will not be available unless specifically requested. To allow access to secure data, contact Fountain at support@fountain.com for help. We’ll provide you with a secure-fields specific API key which you can use with Get Worker Info to retrieve secure data with the rest of a worker’s information.\n\n## Response Schema\n\n* additionalProperties: false\n* is_active - *Indicates current status of the worker*\n * Required: no\n * Type: boolean\n * Example: true\n* name - *Worker Name*\n * Required: no\n * Type: string\n * Example: \"Duane Ullrich DVM\"\n* email - *Worker Email*\n * Required: no\n * Type: string\n * Example: \"bonnie_collins@botsfordkautzer.name\"\n* id - *Worker ID*\n * Required: no\n * Type: string\n * Example: \"ad91e6da-51d7-4c53-b5eb-92350558a1be\"\n* approved_at - *When the worker was hired*\n * Required: no\n * Type: string\n * Format: date-time\n * Example: \"2016-06-29T04:01:17.000-07:00\"\n* data_collection_checks - *Last recurring data collection check collected*\n * Required: no\n * Type: array\n * Items\n  * Required: no\n  * additionalProperties: false\n  * id - *Data Collection Rule ID*\n   * Required: no\n   * Type: string\n   * Example: \"88e78293-c298-4796-b59f-26cf8c179eb2\"\n  * requested_at - *When new data was requested as part of a recurring check in posthire*\n   * Required: no\n   * Type: string\n   * Format: date-time\n   * Example: \"2018-05-01T08:05:00.688-07:00\"\n  * completed_at - NULL\n   * Required: no\n   * Type: string\n   * Format: date-time\n   * Example: \"2018-05-01T08:05:00.688-07:00\"\n  * uploaded_at - *When the worker uploaded requested data*\n   * Required: no\n   * Type: string\n   * Format: date-time\n   * Example: \"2018-05-01T08:05:00.688-07:00\"\n  * rejected_at - *When the user rejected uploaded data*\n   * Required: no\n   * Type: string\n   * Format: date-time\n   * Example: \"2018-05-01T08:05:00.688-07:00\"\n  * confirmed_at - *When the user approved uploaded data*\n   * Required: no\n   * Type: string\n   * Format: date-time\n   * Example: \"2018-05-01T08:05:00.688-07:00\"\n  * canceled_at - *When the recurring check was cancelled*\n   * Required: no\n   * Type: string\n   * Format: date-time\n   * Example: \"2018-05-01T08:05:00.688-07:00\"\n  * status - *Status of data collection check: Pending | Uploaded | Confirmed*\n   * Required: no\n   * Type: string\n   * Example: \"confirmed\"\n  * confirmed_user - *User that approved uploaded data*\n   * Required: no\n   * Type: string\n   * Example: \"Ben\"","excerpt":"","slug":"get-worker-info","type":"endpoint","title":"Get Worker Info"}

getGet Worker Info


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string550e8400-e29b-41d4-a716-446655440000
Worker ID (Required)

Query Params

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

Examples


Result Format


Documentation

A standard GET call for worker info yields basic worker data, status and the last data collection checks collected and approved in posthire. Supply the worker id (same as applicant id) and Fountain will return the corresponding worker info. Note that data collected via a secure field will not be available unless specifically requested. To allow access to secure data, contact Fountain at support@fountain.com for help. We’ll provide you with a secure-fields specific API key which you can use with Get Worker Info to retrieve secure data with the rest of a worker’s information. ## Response Schema * additionalProperties: false * is_active - *Indicates current status of the worker* * Required: no * Type: boolean * Example: true * name - *Worker Name* * Required: no * Type: string * Example: "Duane Ullrich DVM" * email - *Worker Email* * Required: no * Type: string * Example: "bonnie_collins@botsfordkautzer.name" * id - *Worker ID* * Required: no * Type: string * Example: "ad91e6da-51d7-4c53-b5eb-92350558a1be" * approved_at - *When the worker was hired* * Required: no * Type: string * Format: date-time * Example: "2016-06-29T04:01:17.000-07:00" * data_collection_checks - *Last recurring data collection check collected* * Required: no * Type: array * Items * Required: no * additionalProperties: false * id - *Data Collection Rule ID* * Required: no * Type: string * Example: "88e78293-c298-4796-b59f-26cf8c179eb2" * requested_at - *When new data was requested as part of a recurring check in posthire* * Required: no * Type: string * Format: date-time * Example: "2018-05-01T08:05:00.688-07:00" * completed_at - NULL * Required: no * Type: string * Format: date-time * Example: "2018-05-01T08:05:00.688-07:00" * uploaded_at - *When the worker uploaded requested data* * Required: no * Type: string * Format: date-time * Example: "2018-05-01T08:05:00.688-07:00" * rejected_at - *When the user rejected uploaded data* * Required: no * Type: string * Format: date-time * Example: "2018-05-01T08:05:00.688-07:00" * confirmed_at - *When the user approved uploaded data* * Required: no * Type: string * Format: date-time * Example: "2018-05-01T08:05:00.688-07:00" * canceled_at - *When the recurring check was cancelled* * Required: no * Type: string * Format: date-time * Example: "2018-05-01T08:05:00.688-07:00" * status - *Status of data collection check: Pending | Uploaded | Confirmed* * Required: no * Type: string * Example: "confirmed" * confirmed_user - *User that approved uploaded data* * Required: no * Type: string * Example: "Ben"

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