{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/user/details","auth":"required","settings":"","results":{"codes":[{"name":"","code":"[ \n\t\"<company_id>\": {\n\t\t\"company\": { Company },\n    \"messaging\": {\n\t\t\t\"questionnaire_template\": {\n        \"type\": String,\n        \"body\": String\n\t\t\t},\n      \"subject_template\": {\n        \"type\": String\n        \"body\": String\n      }\n\t\t},\n    \"reasons\": {\n    \t\"disposition\": [\n        {\n          \"name\": String,\n          \"_id\": String\n        }, . . .               \n      ],\n    \t\"creation_date\": Date,\n    \t\"updated_date\": Date\n    },\n    \"questionnaires\": [           \n    \t{ Questionnaire },\n      ...            \n    ],\n    \"pipelines\": {\n      \"<pipeline_id>\": { Pipeline },\n      ...           \n    },\n    \"interview_guides\": [\n      { Interview Guide },\n      ...\n    ],\n    \"templates\": [\n      { Template },\n      ...        \n    ],\n    \"tasks\": [\n      { Task },\n      ...        \n    ],\n    \"scorecards\": [\n      { Scorecard },\n      ... \n    ],\n    \"user_settings\": {\n      \"webcal_uri\": String \n    },\n    \"positions\": {\n      \"<position_id>\": { Position },\n      ...\n    },\n    \"members\": [\n      { User },\n      ...\n    ]\n  },\n\t...\n]","language":"json","status":200},{"code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","language":"json","status":400,"name":"Missing Access Token"},{"name":"User Not Found","status":404,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"userNotFound\",\n        \"message\": \"user not found.\"\n    }\n}"},{"status":401,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}"},{"code":"{\n    \"error\": {\n        \"type\": \"getUserCompaniesDetailError\",\n        \"message\": \"there was an unknown error getting user company details.\"\n    }\n}","language":"json","status":500}]},"method":"get","examples":{"codes":[{"language":"curl","code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" https://api.breezy.hr/v3/user/details"}]},"params":[],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"/user/details","type":"endpoint","slug":"user-details","excerpt":"Retrieve the details for the configurations of each company the authenticated user belongs to.","body":"","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a6229e33f8fd80012160748","project":"54ee19c23749bf0d00c76515","version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5a60f64d792a330012d72141","5a60f64d792a330012d72142","5a60f64d792a330012d72143","5a60f64d792a330012d72144","5a60f64d792a330012d72145","5a60f64d792a330012d72146","5a60f64d792a330012d72147","5a660cc7dc0f1c001c2b5568","5d1f4985a718ba002bfa4a52","5d1f53e3d10632001825a1f3"],"_id":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","createdAt":"2018-01-18T19:32:29.915Z","releaseDate":"2018-01-18T19:32:29.915Z","__v":4},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"User Endpoints","slug":"user-endpoints","order":3,"from_sync":false,"reference":true,"_id":"5a60f64d792a330012d72143","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","createdAt":"2015-02-25T20:52:57.796Z","__v":0},"user":"575f003663430e0e008a8704","createdAt":"2018-01-19T17:24:51.452Z","githubsync":"","__v":0,"parentDoc":null,"updatedAt":"2019-07-05T13:03:14.843Z"}

get/user/details

Retrieve the details for the configurations of each company the authenticated user belongs to.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


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