{"openapi": "3.0.3", "info": {"title": "Betterworks API", "version": "v1", "x-logo": {"url": "https://www.betterworks.com/wp-content/uploads/2022/06/BW_Logo_Black.svg", "altText": "Betterworks Logo", "href": "https://www.betterworks.com/"}, "description": "Last updated: 6-JUN-2025"}, "paths": {"/api/v1/calibration/cycle-templates/": {"get": {"operationId": "list_calibration_cycle_templates", "description": "Returns a list of calibration cycle templates.", "summary": "Get a list of calibration cycle templates", "parameters": [{"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}], "tags": ["Calibration"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Calibration_Cycle_Template_List"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": "53a417d8-9889-4ce3-8645-f02e19f05ab0", "type": "cycle_template", "name": "<Cycle Template Name>", "configuration": {"matrix": {"axes": {"x": {"title": "<X Axis Title>", "labels": ["Fair", "Good", "Excellent"], "length": 3, "talent_key": "rating_performance_calibration"}}, "content": [{"bg": "#FF7569", "color": "#000000", "label": "Holding On"}, {"bg": "#EDDC42", "color": "#000000", "label": "Solid and Steady"}, {"bg": "#29BE7A", "color": "#000000", "label": "Leading Edge"}], "dimensions": 1, "visibility": {"box_numbers": true}}, "histogram": {"title": "<Histogram Title>", "content": [{"bg": "#FF7569", "color": "#000000"}, {"bg": "#FFB54E", "color": "#000000"}, {"bg": "#EDDC42", "color": "#000000"}, {"bg": "#70CA35", "color": "#000000"}, {"bg": "#29BE7A", "color": "#000000"}], "label_type": "text", "talent_key": "rating_performance_employee"}, "talent_records": {"columns": [{"label": "<Column Label>", "sortable": false, "read_only": true, "talent_key": "nine_box_position", "display_type": "text"}, {"label": "<Column Label>", "sortable": false, "read_only": false, "talent_key": "rating_performance_calibration", "display_type": "select"}, {"label": "<Column Label>", "sortable": false, "read_only": false, "talent_key": "rating_potential_calibration", "display_type": "select"}]}}, "created_on": "2022-10-18T20:47:06.440Z", "created_by": 1, "modified_on": "2022-11-01T20:38:10.000Z", "modified_by": 12, "mappings": [{"type": "talent_keymap", "id": "f12ffc76-6608-4d1c-a05c-02624c9cda2a", "properties": {"created_by": 1, "created_on": "2022-10-18T20:47:06.445Z", "cycle_template_id": "53a417d8-9889-4ce3-8645-f02e19f05ab0", "expression": "rating_performance_manager", "modified_by": "2022-11-01T20:38:10.000Z", "modified_on": 12, "talent_key": "rating_performance_calibration"}}]}], "more": true, "nextUrl": "/api/v1/calibration/cycle-templates/?page=2&size=1"}, "summary": "Example success response", "description": "List of calibration cycle templates"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/calibration/cycle-templates/{cycle_template_id}/": {"get": {"operationId": "get_calibration_cycle_template", "description": "Returns a calibration cycle template.", "summary": "Get a calibration cycle template", "parameters": [{"in": "path", "name": "cycle_template_id", "schema": {"type": "string", "format": "uuid"}, "description": "The calibration cycle template UUID", "required": true}], "tags": ["Calibration"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Calibration_Cycle_Template"}, "examples": {"ExampleSuccessResponse": {"value": {"id": "53a417d8-9889-4ce3-8645-f02e19f05ab0", "type": "cycle_template", "name": "<Cycle Template Name>", "configuration": {"matrix": {"axes": {"x": {"title": "<X Axis Title>", "labels": ["Fair", "Good", "Excellent"], "length": 3, "talent_key": "rating_performance_calibration"}}, "content": [{"bg": "#FF7569", "color": "#000000", "label": "Holding On"}, {"bg": "#EDDC42", "color": "#000000", "label": "Solid and Steady"}, {"bg": "#29BE7A", "color": "#000000", "label": "Leading Edge"}], "dimensions": 1, "visibility": {"box_numbers": true}}, "histogram": {"title": "<Histogram Title>", "content": [{"bg": "#FF7569", "color": "#000000"}, {"bg": "#FFB54E", "color": "#000000"}, {"bg": "#EDDC42", "color": "#000000"}, {"bg": "#70CA35", "color": "#000000"}, {"bg": "#29BE7A", "color": "#000000"}], "label_type": "text", "talent_key": "rating_performance_employee"}, "talent_records": {"columns": [{"label": "<Column Label>", "sortable": false, "read_only": true, "talent_key": "nine_box_position", "display_type": "text"}, {"label": "<Column Label>", "sortable": false, "read_only": false, "talent_key": "rating_performance_calibration", "display_type": "select"}, {"label": "<Column Label>", "sortable": false, "read_only": false, "talent_key": "rating_potential_calibration", "display_type": "select"}]}}, "created_on": "2022-10-18T20:47:06.440Z", "created_by": 1, "modified_on": "2022-11-01T20:38:10.000Z", "modified_by": 12, "mappings": [{"type": "talent_keymap", "id": "f12ffc76-6608-4d1c-a05c-02624c9cda2a", "properties": {"created_by": 1, "created_on": "2022-10-18T20:47:06.445Z", "cycle_template_id": "53a417d8-9889-4ce3-8645-f02e19f05ab0", "expression": "rating_performance_manager", "modified_by": "2022-11-01T20:38:10.000Z", "modified_on": 12, "talent_key": "rating_performance_calibration"}}]}, "summary": "Example success response", "description": "Calibration cycle template details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": ["the following cycle_template_id is not a valid UUID: <invalid UUID>"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "404": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": ["unable to find resource with id <UUID>"]}}}}}, "description": "Not Found"}}}}, "/api/v1/calibration/cycles/": {"get": {"operationId": "list_calibration_cycles", "description": "Returns a list of calibration cycles.", "summary": "Get a list of calibration cycles", "parameters": [{"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}], "tags": ["Calibration"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Calibration_Cycle_Response_List"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": "a8b62c6b-c19b-4f47-99cf-c99e99d3173e", "name": "<Calibration Cycle Name>", "conversation_cycle_id": 49}], "more": true, "nextUrl": "/api/v1/cycles/?size=1&page=2"}, "summary": "Example success response", "description": "List of cycles"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/calibration/cycles/{cycle_id}/": {"get": {"operationId": "get_calibration_cycle", "description": "Returns a calibration cycle.", "summary": "Get a calibration cycle", "parameters": [{"in": "path", "name": "cycle_id", "schema": {"type": "string", "format": "uuid"}, "description": "The calibration cycle UUID", "required": true}], "tags": ["Calibration"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Calibration_Cycle_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"id": "a8b62c6b-c19b-4f47-99cf-c99e99d3173e", "name": "<Calibration Cycle Name>", "conversation_cycle_id": 49}, "summary": "Example success response", "description": "Calibration cycle details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": ["the following cycle_id is not a valid UUID: <invalid UUID>"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "404": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": ["unable to find resource with id <UUID>"]}}}}}, "description": "Not Found"}}}}, "/api/v1/calibration/talent-records/": {"get": {"operationId": "list_calibration_talent_records", "description": "Returns a list of calibration talent records.", "summary": "Get a list of calibration talent records", "parameters": [{"in": "query", "name": "cycle_id", "schema": {"type": "string", "format": "uuid"}, "description": "The calibration cycle UUID", "required": true}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}], "tags": ["Calibration"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Calibration_Cycle_TalentRecord_List"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": "5873d5e9-cff4-48d9-9e2c-137c5a210efe", "subject_id": 581, "cycle_id": "a8b62c6b-c19b-4f47-99cf-c99e99d3173e", "comments_employee": "<Employee Comment>", "comments_manager": "<Manager Comment>", "compensation_raise": "6700", "compensation_raise_percent": "0.05", "critical_skills": "<Critical Skill>", "development_opportunities": "<Development Opportunity>", "internal_mobility": true, "potential_next_roles": "<Role Name>", "promotion_promote": true, "promotion_rationale": "<Rationale>", "promotion_role": "<Role>", "relocate": false, "fellowships": false, "special_program": false, "nominate_as_mentor": true, "nine_box_position": [1, 2], "created_on": "2022-10-18T20:47:06.524Z", "created_by": 1, "modified_on": "2022-11-01T20:38:10.000Z", "modified_by": 12, "ratings": [{"id": "f99f43fd-342b-4dc6-90ba-9e4f1ec1536c", "rating_type_id": "be220b6d-320b-48e5-ba8b-ff7672eb97f0", "value": 0, "talent_key": "rating_performance_manager", "scale": {"min": 0, "max": 2, "options": {"0": "Unsatisfactory", "1": "Meets Expectations", "2": "Excellent"}}}, {"id": "8f9579c5-07c5-43a8-99b4-247e8c31359d", "rating_type_id": "695cd04b-9a05-427c-8a8e-1eb3f4c8b2c7", "value": 0, "talent_key": "rating_performance_calibration", "scale": {"min": 0, "max": 2, "options": {"0": "Unsatisfactory", "1": "Meets Expectations", "2": "Excellent"}}}]}], "more": true, "nextUrl": "/api/v1/calibration/talent-records?cycle_id=<uuid>&page=2&size=1"}, "summary": "Example success response", "description": "List of calibration talent records."}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": ["cycle id <UUID> not found", "cycle_id must be a valid GUID"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/calibration/talent-records/{talent_record_id}/": {"get": {"operationId": "get_calibration_talent_record", "description": "Returns a calibration talent record.", "summary": "Get a calibration talent record", "parameters": [{"in": "path", "name": "talent_record_id", "schema": {"type": "string", "format": "uuid"}, "description": "The calibration talent record UUID", "required": true}], "tags": ["Calibration"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Calibration_Cycle_TalentRecord"}, "examples": {"ExampleSuccessResponse": {"value": {"id": "5873d5e9-cff4-48d9-9e2c-137c5a210efe", "subject_id": 581, "cycle_id": "a8b62c6b-c19b-4f47-99cf-c99e99d3173e", "comments_employee": "<Employee Comment>", "comments_manager": "<Manager Comment>", "compensation_raise": "6700", "compensation_raise_percent": "0.05", "critical_skills": "<Critical Skill>", "development_opportunities": "<Development Opportunity>", "internal_mobility": true, "potential_next_roles": "<Role Name>", "promotion_promote": true, "promotion_rationale": "<Rationale>", "promotion_role": "<Role>", "relocate": false, "fellowships": false, "special_program": false, "nominate_as_mentor": true, "nine_box_position": [1, 2], "created_on": "2022-10-18T20:47:06.524Z", "created_by": 1, "modified_on": "2022-11-01T20:38:10.000Z", "modified_by": 12, "ratings": [{"id": "f99f43fd-342b-4dc6-90ba-9e4f1ec1536c", "rating_type_id": "be220b6d-320b-48e5-ba8b-ff7672eb97f0", "value": 0, "talent_key": "rating_performance_manager", "scale": {"min": 0, "max": 2, "options": {"0": "Unsatisfactory", "1": "Meets Expectations", "2": "Excellent"}}}, {"id": "8f9579c5-07c5-43a8-99b4-247e8c31359d", "rating_type_id": "695cd04b-9a05-427c-8a8e-1eb3f4c8b2c7", "value": 0, "talent_key": "rating_performance_calibration", "scale": {"min": 0, "max": 2, "options": {"0": "Unsatisfactory", "1": "Meets Expectations", "2": "Excellent"}}}]}, "summary": "Example success response", "description": "Calibration talent record details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": ["the following talent_record_id is not a valid UUID: <invalid UUID>"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "404": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": ["unable to find resource with id <UUID>"]}}}}}, "description": "Not Found"}}}}, "/api/v1/conversations/": {"get": {"operationId": "list_conversations", "description": "Returns a list of conversations.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Get a list of conversations", "parameters": [{"in": "query", "name": "delta_end", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or before the given date\n            - example: `2021-12-31T23:59:59Z`\n        "}, {"in": "query", "name": "delta_start", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or after the given date\n            - example: `2020-01-01T00:00:00Z`\n        "}, {"in": "path", "name": "deployment_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The deployment ID associated with the conversations", "required": true}, {"in": "query", "name": "employee_id", "schema": {"type": "integer"}, "description": "Filter conversations on an employee ID"}, {"in": "query", "name": "manager_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "Filter conversations on a manager ID"}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}], "tags": ["Conversations"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Conversations_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 1, "uuid": "e98d4f17-99c5-418a-ac70-f1fe27c739f7", "type": "scheduled", "name": "<Conversation Name>", "description": "<Description Text>", "deployment_id": 123, "manager": {"name": "<First Name> <Last Name>", "id": 23, "uuid": "e83461a4-fa06-4014-80d3-e3e6cc3c1ccc"}, "employee": {"name": "<First Name> <Last Name>", "id": 40, "uuid": "1aac7892-fd6f-4e89-88d6-2c7ae4657681"}, "contributors": [{"user": {"name": "<First Name> <Last Name>", "id": 53, "uuid": "c4c84b58-e38d-436c-920a-eee60d9af648"}, "status": "shared", "response": "<Response Text>"}], "start": "2021-04-26", "end": "2021-04-28", "marked_as_met": "not_met", "manager_response": {"id": 27, "uuid": "c4c84b58-e38d-436c-920a-eee60d9af648", "name": "<First Name> <Last Name>", "description": "<Description Text>", "shared_on": 1647848875.409886, "submitted_on": 1650014212.357601, "unlocked_until": 1660014212.357601, "responses": [{"id": 12345, "uuid": "2b3535c4-17e1-422b-9e13-93e373f23f72", "type": "multiple_choice", "question_id": 25196, "question": "<Question Text>", "question_options": ["Option 1", "Option 2", "Option 3", "Option 4"], "answer": "<Answer Text>", "lock_date": null, "created": 1646926650.753365, "updated": 1646926650.753365, "created_on": "2022-03-10 15:37:30.756187Z", "modified_on": "2022-03-10 15:37:30.756248Z"}], "updated": 1619290862.0, "updated_by": {"name": "<First Name> <Last Name>", "id": 11, "uuid": "e83461a4-fa06-4014-80d3-e3e6cc3c1ccc"}, "created": 1619290862.0, "created_by": {"name": "<First Name> <Last Name>", "id": 11, "uuid": "e83461a4-fa06-4014-80d3-e3e6cc3c1ccc"}, "created_on": "2022-03-10 15:37:30.704686Z", "modified_on": "2022-03-10 15:37:30.704731Z"}, "employee_response": {"id": 276, "uuid": "d3c85b43-7dd7-4f32-9b12-820688f77b9e", "name": "<First Name> <Last Name>", "description": "", "shared_on": 1647848875.409886, "submitted_on": 1640014212.357601, "unlocked_until": 1650014212.357601, "responses": [{"id": 13847334, "uuid": "3c32dd12-dd42-4fdf-81cf-75e82d763d8e", "type": "text", "question": "<Question Text>", "question_options": null, "answer": "<Answer Text>", "lock_date": null, "created": 1619290863.0, "updated": 1619290863.0, "created_on": "2022-03-10 15:37:30.811117Z", "modified_on": "2022-03-10 15:37:30.811170Z"}], "updated": 1619290862.0, "updated_by": {"name": "<First Name> <Last Name>", "id": 11, "uuid": "bf27a23e-e69b-4b94-9d73-a8436714136c"}, "created": 1619290862.0, "created_by": {"name": "<First Name> <Last Name>", "id": 11, "uuid": "bf27a23e-e69b-4b94-9d73-a8436714136c"}, "created_on": "2022-03-10 15:37:30.785382Z", "modified_on": "2022-03-10 15:37:30.78543Z"}, "post_employee_response": {"id": 31, "uuid": "ba9c7a6f-2658-4c9b-8bfa-2b699f2249c5", "name": "<First Name> <Last Name>", "description": "<Description Text>", "shared_on": 1647848875.409886, "submitted_on": 1650014212.357601, "unlocked_until": 1660014212.357601, "responses": [{"id": 14, "uuid": "3c32dd12-dd42-7z1f-81cf-75e82d763d8e", "type": "text", "question": "<Question Text>", "question_options": null, "answer": "<Answer Text>", "lock_date": null, "created": 1619290862.0, "updated": 1619290862.0, "created_on": "2022-03-10 15:37:30.785382Z", "modified_on": "2022-03-10 15:37:30.785433Z"}], "updated": 1619290862.0, "updated_by": {"name": "<First Name> <Last Name>", "id": 11, "uuid": "fad590a1-e751-40ab-a9e4-94e809099b0e"}, "created": 1619290862.0, "created_by": {"name": "<First Name> <Last Name>", "id": 11, "uuid": "fad590a1-e751-40ab-a9e4-94e809099b0e"}, "created_on": "2022-03-10 15:37:30.785382Z", "modified_on": "2022-03-10 15:37:30.785433Z"}, "post_manager_response": {"id": 3101916, "uuid": "dccc2954-7c89-4391-bc96-15681d7828dc", "name": "<First Name> <Last Name>", "description": "<Description Text>", "shared_on": 1629914212.357601, "submitted_on": 1630014212.357601, "unlocked_until": 1640014212.357601, "responses": [{"id": 14724707, "uuid": "6e13161d-88af-4094-b80d-cb223bf70436", "type": "text", "question": "<Question Text>", "question_options": null, "answer": "<Answer Text>", "lock_date": null, "created": 1619290862.0, "updated": 1619290862.0, "created_on": "2022-03-10 15:37:30.785382Z", "modified_on": "2022-03-10 15:37:30.785433Z"}], "updated": 1619290862.0, "updated_by": {"name": "<First Name> <Last Name>", "id": 3, "uuid": "1016f966-c64d-46f6-8fb9-c1145cf04306"}, "created": 1619290862.0, "created_by": {"name": "<First Name> <Last Name>", "id": 1, "uuid": "28cc30ed-e8c6-4052-837f-d2dedb220378"}, "created_on": "2022-03-10 15:37:30.785382+00:00", "modified_on": "2022-03-10 15:37:30.785433+00:00"}, "employee_submit_end": "2021-04-01", "manager_submit_end": "2021-04-02", "grace_period_end": "2021-04-10", "employee_review_end": "2021-04-11", "manager_review_end": "2021-04-12", "manager_status": "post_hr_not_started", "employee_status": "not_started", "employee_notes": "<Employee Notes Text>", "employee_notes_updated": 1671290862.0, "manager_notes": "<Manager Notes Text>", "manager_notes_updated": 1699290862.0, "post_manager_questionnaire_pending": true, "post_employee_questionnaire_pending": true, "created": 1619290862.0, "created_by": {"name": "<First Name> <Last Name>", "id": 11, "uuid": "bf27a23e-e69b-4b94-9d73-a8436714136c"}, "created_on": "2022-03-29 09:02:29.622155Z", "modified_on": "2022-03-29 09:02:29.707286Z"}], "more": true, "nextUrl": "/api/v1/conversations/?size=1&page=2"}, "summary": "Example success response", "description": "List of conversations"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}}, "/api/v1/conversations/templates/": {"get": {"operationId": "list_conversation_templates", "description": "Returns a list of conversation templates.\n            <strong>This endpoint is only available to users with the admin or super admin role.</strong>", "summary": "Get a list of conversation templates", "parameters": [{"in": "query", "name": "enabled", "schema": {"type": "boolean"}, "description": "Filter conversation templates by enabled conversations"}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}, {"in": "query", "name": "type", "schema": {"type": "string", "enum": ["adhoc", "scheduled"]}, "description": "Filter conversation templates by type"}], "tags": ["Conversations"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Conversation_Templates_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 41, "uuid": "e98d4f17-99c5-418a-ac70-f1fe27c739f7", "type": "scheduled", "description": "<Conversation Template Description>", "enabled": false, "require_marked_as_met": true, "only_managers_can_initiate": false, "allowed_employees": [{"id": 1511, "name": "<First Name> <Last Name>", "is_active": true, "email": "<Email>"}], "allowed_groups": [371], "is_goal_creation_enabled": true, "hrq_enabled": true, "hrq_is_concurrent": false, "hrq_notification_on_start": false, "hrq_notification_on_due": false, "notification_on_start": true, "notification_on_end": true, "notification_midcycle_days": 2, "notification_overdue_days": 2, "super_admin_permission": "can_only_view", "hr_admin_permission": "can_only_view", "skip_level_managers_permission": "no_access", "skip_level_managers_level": "none", "matrix_manager_enabled": true, "matrix_manager_can_see_responses": true, "matrix_manager_can_see_direct_report_responses": true, "deployments": [{"id": 25, "uuid": "8c9e0068-ea7d-409f-87f2-fd67b9jl2638", "name": "<Conversation Name>", "description": "<Conversation Description>", "cycles": [{"id": 40, "uuid": "bff67539-249e-516d-84c3-c026da93372d", "role": "manager", "stage": "primary", "start": "2020-11-26", "end": "2021-03-06", "lock_on_share": true, "lock_date": "2021-02-28", "review_end": "2021-01-31", "submit_end": "2021-02-06", "grace_period_end": "2021-02-10"}]}], "participants": ["employee", "manager"], "hrq_participants": ["employee", "manager"], "created": 1606266306.0, "created_by": {"name": "<First Name> <Last Name>", "id": 67, "uuid": "e83461a4-fa06-4014-80d3-e3e6cc3c1ccc"}, "updated": 1606266306.0, "updated_by": {"name": "<First Name> <Last Name>", "id": 67, "uuid": "e83461a4-fa06-4014-80d3-e3e6cc3c1ccc"}, "created_on": "2020-11-26T17:06:06.000Z", "modified_on": "2020-11-26T17:06:06.000Z"}], "more": true, "nextUrl": "/api/v1/conversations/templates/?page=2&size=1"}, "summary": "Example success response", "description": "List of conversation templates"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}}, "/api/v1/conversations/templates/{template_id}/": {"get": {"operationId": "get_conversation_template", "description": "Returns a conversation template.\n            <strong>This endpoint is only available to users with the admin or super admin role.</strong>", "summary": "Get a conversation template", "parameters": [{"in": "path", "name": "template_id", "schema": {"type": "integer"}, "description": "The conversation template ID", "required": true}], "tags": ["Conversations"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Conversation_Template"}, "examples": {"ExampleSuccessResponse": {"value": {"id": 41, "uuid": "e98d4f17-99c5-418a-ac70-f1fe27c739f7", "type": "scheduled", "description": "<Conversation Template Description>", "enabled": false, "require_marked_as_met": true, "only_managers_can_initiate": false, "allowed_employees": [{"id": 1511, "name": "<First Name> <Last Name>", "is_active": true, "email": "<Email>"}], "allowed_groups": [371], "is_goal_creation_enabled": true, "hrq_enabled": true, "hrq_is_concurrent": false, "hrq_notification_on_start": false, "hrq_notification_on_due": false, "notification_on_start": true, "notification_on_end": true, "notification_midcycle_days": 2, "notification_overdue_days": 2, "super_admin_permission": "can_only_view", "hr_admin_permission": "can_only_view", "skip_level_managers_permission": "no_access", "skip_level_managers_level": "none", "matrix_manager_enabled": true, "matrix_manager_can_see_responses": true, "matrix_manager_can_see_direct_report_responses": true, "deployments": [{"id": 25, "uuid": "8c9e0068-ea7d-409f-87f2-fd67b9jl2638", "name": "<Conversation Name>", "description": "<Conversation Description>", "cycles": [{"id": 40, "uuid": "bff67539-249e-516d-84c3-c026da93372d", "role": "manager", "stage": "primary", "start": "2020-11-26", "end": "2021-03-06", "lock_on_share": true, "lock_date": "2021-02-28", "review_end": "2021-01-31", "submit_end": "2021-02-06", "grace_period_end": "2021-02-10"}]}], "participants": ["employee", "manager"], "hrq_participants": ["employee", "manager"], "created": 1606266306.0, "created_by": {"name": "<First Name> <Last Name>", "id": 67, "uuid": "e83461a4-fa06-4014-80d3-e3e6cc3c1ccc"}, "updated": 1606266306.0, "updated_by": {"name": "<First Name> <Last Name>", "id": 67, "uuid": "e83461a4-fa06-4014-80d3-e3e6cc3c1ccc"}, "created_on": "2020-11-26T17:06:06.000Z", "modified_on": "2020-11-26T17:06:06.000Z"}, "summary": "Example success response", "description": "Conversation template details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid template_id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}}, "/api/v1/departments/": {"get": {"operationId": "list_departments", "description": "Returns a list of departments.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Get a list of departments", "parameters": [{"in": "query", "name": "include_deactivated", "schema": {"type": "boolean", "default": false}, "description": "Include deactivated departments"}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}], "tags": ["Departments"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Departments_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [[{"id": 2, "uuid": "8e9c167a-3312-49f6-8221-bfd9ef74f540", "name": "<Department Name>", "parent": {"name": "<Parent Department Name>", "id": 1, "uuid": "1fbb5fd3-3071-4d07-b803-ff2ecf27a74e"}, "is_active": true, "created_on": "2022-11-14T22:41:07.881481Z", "modified_on": "2022-11-14T22:41:07.881542Z"}]], "page": 1, "num_pages": 2, "more": true, "nextUrl": "/api/v1/departments/?size=1&page=2"}, "summary": "Example success response", "description": "List of departments"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}, "post": {"operationId": "create_department", "description": "Returns the created department.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Create a new department", "tags": ["Departments"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "example": "Engineering"}, "parent_id": {"type": "integer", "example": 326}}}}}}, "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Department"}, "examples": {"ExampleSuccessResponse": {"value": [{"id": 2, "uuid": "8e9c167a-3312-49f6-8221-bfd9ef74f540", "name": "<Department Name>", "parent": {"name": "<Parent Department Name>", "id": 1, "uuid": "1fbb5fd3-3071-4d07-b803-ff2ecf27a74e"}, "is_active": true, "created_on": "2022-11-14T22:41:07.881481Z", "modified_on": "2022-11-14T22:41:07.881542Z"}], "summary": "Example success response", "description": "Department details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "The <department_name> department already\n                                   exists. Please enter a different name."}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}}, "/api/v1/departments/{department_id}/": {"put": {"operationId": "update_department", "description": "Returns the updated department.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Update a department", "parameters": [{"in": "path", "name": "department_id", "schema": {"type": "integer"}, "description": "The ID of the department to update", "required": true}], "tags": ["Departments"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "example": "Engineering"}, "parent_id": {"type": "integer", "example": 326}}}}}}, "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Department"}, "examples": {"ExampleSuccessResponse": {"value": [{"id": 2, "uuid": "8e9c167a-3312-49f6-8221-bfd9ef74f540", "name": "<Department Name>", "parent": {"name": "<Parent Department Name>", "id": 1, "uuid": "1fbb5fd3-3071-4d07-b803-ff2ecf27a74e"}, "is_active": true, "created_on": "2022-11-14T22:41:07.881481Z", "modified_on": "2022-11-14T22:41:07.881542Z"}], "summary": "Example success response", "description": "Department details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "This group does not exist: <group_id>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}, "404": {"content": {"text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}}, "/api/v1/departments/{department_id}/deactivate/": {"post": {"operationId": "deactivate_department", "description": "Returns the deactivated department (department must be empty).\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Deactivate a department", "parameters": [{"in": "path", "name": "department_id", "schema": {"type": "integer"}, "description": "The ID of the department to deactivate", "required": true}], "tags": ["Departments"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Department"}, "examples": {"ExampleSuccessResponse": {"value": [{"id": 2, "uuid": "8e9c167a-3312-49f6-8221-bfd9ef74f540", "name": "<Department Name>", "parent": {"name": "<Parent Department Name>", "id": 1, "uuid": "1fbb5fd3-3071-4d07-b803-ff2ecf27a74e"}, "is_active": true, "created_on": "2022-11-14T22:41:07.881481Z", "modified_on": "2022-11-14T22:41:07.881542Z"}], "summary": "Example success response", "description": "Department details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["This department cannot be deactivated until all active users are removed.", "Department <department_name> already deactivated", "The group does not exist: <group_id>"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}, "404": {"content": {"text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}}, "/api/v1/departments/{department_id}/reactivate/": {"post": {"operationId": "reactivate_department", "description": "Returns the reactivated department.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Reactivate a department", "parameters": [{"in": "path", "name": "department_id", "schema": {"type": "integer"}, "description": "The ID of the department to reactivate", "required": true}], "tags": ["Departments"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Department"}, "examples": {"ExampleSuccessResponse": {"value": [{"id": 2, "uuid": "8e9c167a-3312-49f6-8221-bfd9ef74f540", "name": "<Department Name>", "parent": {"name": "<Parent Department Name>", "id": 1, "uuid": "1fbb5fd3-3071-4d07-b803-ff2ecf27a74e"}, "is_active": true, "created_on": "2022-11-14T22:41:07.881481Z", "modified_on": "2022-11-14T22:41:07.881542Z"}], "summary": "Example success response", "description": "Department details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["This group does not exist: <group_id>", "Department <department_name already activated"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}, "404": {"content": {"text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}}, "/api/v1/departments/bulk/": {"post": {"operationId": "bulk_edit_departments", "description": "Returns the number of created and updated departments.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Create or update multiple departments", "tags": ["Departments"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["departments"], "properties": {"departments": {"type": "array", "title": "Department", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "example": "<Department Name>"}, "parent_name": {"type": "string", "example": "<Parent Department Name>"}}}}}}}}}, "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Departments_Bulk_Update_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"updated": 12, "created": 6}, "summary": "Example success response", "description": "Summary of created and updated departments"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": "The <department_name> department already exists. Please\n                            enter a different name."}}}}}, "description": "Bad request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}}, "/api/v1/feedback/": {"get": {"operationId": "list_feedback", "description": "Returns a list of feedback. \n\n            \n The request must include `cycle_id` and/or `for_user_id`.\n            If `cycle_id`, all feedback related to that cycle id will be populated.\n            If `for_user_id`, all feedback related to that user id will be populated.", "summary": "Get a list of feedback", "parameters": [{"in": "query", "name": "cycle_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The feedback cycle ID"}, {"in": "query", "name": "delta_end", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or before the given date\n            - example: `2021-12-31T23:59:59Z`\n        "}, {"in": "query", "name": "delta_start", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or after the given date\n            - example: `2020-01-01T00:00:00Z`\n        "}, {"in": "query", "name": "for_user_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The ID of the user that received feedback"}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}], "tags": ["Feedback"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Feedback_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 123, "uuid": "9a9949b0-b118-4f4d-a7c2-5fc0d41d2ffe", "name": "<Feedback Name>", "cycle_id": 234, "cycle": null, "for_user": {"name": "<First Name> <Last Name>", "id": 345, "uuid": "f46c96d9-6147-4154-833f-4d90d04e39d5"}, "requested_by": null, "created": 1670438541.008243, "created_by": {"name": "<First Name> <Last Name>", "id": 456, "uuid": "ed0bd3c4-a85b-4a0a-a26b-81ad19070daf"}, "updated": 1670438541.008269, "responses": [{"id": 567, "uuid": "3fe07f97-a87b-4faf-8981-cc27fd694bfa", "question": "<Question Text>", "question_id": 678, "question_uuid": "893af3e4-9e4d-46cf-acf7-1a7c5c26c25c", "question_options": null, "type": "text", "feedback_id": 789, "answer": "<Answer Text>", "hide_numbers": false}], "created_on": "2022-12-07T18:42:21.008100Z", "modified_on": "2022-12-07T18:42:21.008160Z", "employee_can_view": true, "manager_can_view": false, "employee_see_identity": true, "manager_see_identity": false, "hold_feedback": false, "status": "submitted", "template_name": "<Feedback Template Name>", "template_type": "adhoc_request"}], "more": true, "nextUrl": "/api/v1/feedback/?size=1&page=2"}, "summary": "Example success response", "description": "List of feedback"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid cycle_id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/feedback/requests/": {"get": {"operationId": "list_feedback_requests", "description": "Returns a list of feedback requests.", "summary": "Get a list of feedback requests", "parameters": [{"in": "query", "name": "cycle", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The feedback cycle ID"}, {"in": "query", "name": "declined", "schema": {"type": "boolean"}, "description": "Filter on declined feedback requests"}, {"in": "query", "name": "delta_end", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or before the given date\n            - example: `2021-12-31T23:59:59Z`\n        "}, {"in": "query", "name": "delta_start", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or after the given date\n            - example: `2020-01-01T00:00:00Z`\n        "}, {"in": "query", "name": "for_user", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The feedback recipient ID"}, {"in": "query", "name": "from_user", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The feedback provider ID"}, {"in": "query", "name": "is_adhoc", "schema": {"type": "boolean"}, "description": "Filter on anytime feedback requests"}, {"in": "query", "name": "is_open", "schema": {"type": "boolean"}, "description": "Filter on feedback where the status is not `expired`"}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "questions", "schema": {"type": "boolean", "default": false}, "description": "Include questions in feedback requests"}, {"in": "query", "name": "show_all", "schema": {"type": "boolean"}, "description": "Include all feedback requests that are not started or have a status of `answering`"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}], "tags": ["Feedback"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Feedback_Request_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 3877, "uuid": "e98d4f17-99c5-418a-ac70-f1fe27c739f7", "cycle": {"id": 2207, "uuid": "7f98b0b2-e31d-425a-8966-332353cecde3", "cycle_start": "2022-02-15", "selection_end": "2022-02-17", "feedback_start": "2022-02-18", "cycle_end": "2022-02-28", "grace_period_end": "2022-04-22", "enable_anytime_nomination": true}, "adhoc_cycle": {"id": 1014, "template_id": 2662, "template_name": "<Feedback Template Name>", "template_questions": ["<Question One Text>", "<Question Two Text>", "<Question Three Text>"], "questions_locked": false}, "from_user": {"id": 184, "uuid": "8b04af57-a65d-4fe3-8b94-078bad2e0030", "first_name": "<First Name>", "preferred_name": "<Preferred Name>", "last_name": "<Last Name>", "name": "<First Name> <Last Name>", "email": "<Email>", "is_active": true, "deactivated_on": "2021-12-31T19:20:13.616730Z", "deactivation_date": "2021-12-31", "title": "<Title>", "manager": {"name": "<First Name> <Last Name>", "id": 487, "uuid": "623406e0-54f2-407f-84db-d41561cddb83"}, "department": {"name": "<Department Name>", "id": 3, "uuid": "5330cc44-b90d-4a05-ae3b-329128e2f6b6"}, "phone": "<Phone Number>", "about": "<About Text>", "locale": "en", "is_goalmaster": false, "is_super_admin": false, "is_admin": false, "is_group_admin": false, "employee_id": "23", "created_on": "2021-11-10T21:28:48.951160Z", "modified_on": "2022-01-14T03:00:02.095716Z", "attributes": {"on_leave": false}, "custom_values": {"custom_01": "<Custom Value>", "custom_02": "<Custom Value>"}}, "for_user": {"id": 519, "uuid": "d44906e5-7dbc-46f5-b312-5f35937f8cd3", "first_name": "<First Name>", "preferred_name": "<Preferred Name>", "last_name": "<Last Name>", "name": "<First Name> <Last Name>", "email": "<Email>", "is_active": true, "deactivated_on": null, "deactivation_date": null, "title": "Title", "manager": {"name": "<First Name> <Last Name>", "id": 589}, "department": {"name": "<Department Name>", "id": 3, "uuid": "5330cc44-b90d-4a05-ae3b-329128e2f6b6"}, "phone": "<Phone Number>", "about": "<About Text>", "locale": "en", "is_goalmaster": false, "is_super_admin": false, "is_admin": false, "is_group_admin": false, "employee_id": "24", "created_on": "2021-11-10T21:28:48.951160Z", "modified_on": "2021-12-08T00:48:23.249611Z", "attributes": {"preferred_name": "<Preferred Name>", "on_leave": false}, "custom_values": {"custom_03": "<Custom Value>", "custom_04": "<Custom Value>"}}, "requested_by": {"id": 387801, "uuid": "54740921-7031-40d3-bji6-fb798ddf763d", "first_name": "<First Name>", "preferred_name": "<Preferred Name>", "last_name": "<Last Name>", "name": "<First Name> <Last Name>", "email": "<Email>", "is_active": false, "deactivated_on": null, "deactivation_date": null, "title": "Title", "manager": {"name": "<First Name> <Last Name>", "id": 129, "uuid": "f4b989ab-3323-4ead-b2a5-95228ec1b721"}, "department": {"name": "<Department Name>", "id": 4, "uuid": "2c249239-bcba-4900-a164-fcc211942eb1"}, "phone": "", "about": "", "locale": "en", "is_goalmaster": false, "is_super_admin": true, "is_admin": false, "is_group_admin": false, "employee_id": "2341242", "created_on": "2021-12-21T04:54:45.790728Z", "modified_on": "2022-03-16T04:39:00.252944Z", "attributes": {"on_leave": false}, "custom_values": {"custom_05": "<Custom Value>", "custom_06": "<Custom Value>"}}, "feedback_id": 1811, "feedback_uuid": "5cf610b3-830c-41f4-8a4d-5f770fb489ca", "question": "<Question Text>", "declined": null, "can_view_feedback": true, "hold_feedback": false, "created": 1633811615.591184, "created_by": {"id": 519, "uuid": "286dc269-89fc-4b55-97f2-cfab29b0aad6", "first_name": "<First Name>", "preferred_name": "<Preferred Name>", "last_name": "<Last Name>", "name": "<First Name> <Last Name>", "email": "<Email>", "is_active": true, "deactivated_on": null, "deactivation_date": null, "title": "<Title>", "manager": {"name": "<First Name> <Last Name>", "id": 589, "uuid": "e30afc69-1e50-4993-af1d-ddc1f1e3798e"}, "department": {"name": "<Department Name>", "id": 4, "uuid": "2c249239-bcba-4900-a164-fcc211942eb1"}, "phone": "<Phone Number>", "about": "<About Text>", "locale": "en", "is_goalmaster": false, "is_super_admin": false, "is_admin": false, "is_group_admin": false, "employee_id": "513", "attributes": {"on_leave": false}, "custom_values": {"custom_07": "<Custom Value>", "custom_08": "<Custom Value>"}}, "status": 0, "template_id": 7, "template_uuid": "d02f4eb0-8a2c-4880-b76f-db6bbb8f607d", "expired": null, "created_on": "2019-01-01T12:00:00.123456Z", "modified_on": "2019-01-02T12:00:00.123456Z", "custom_note": "<Custom Note>"}], "more": true, "nextUrl": "/api/v1/feedback/requests/?size=1&page=2"}, "summary": "Example success response", "description": "List of feedback requests"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid cycle_id", "invalid user_ud"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/feedback/templates/": {"get": {"operationId": "list_feedback_templates", "description": "Returns a list of feedback templates.", "summary": "Get a list of feedback templates", "parameters": [{"in": "path", "name": "template_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The feedback template ID", "required": true}], "tags": ["Feedback"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Feedback_Template_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 96, "uuid": "3a5c9865-ea2b-4726-ae78-9e613a089536", "type": "scheduled", "name": "<Feedback Name>", "enabled": false, "cycles": [{"id": 95, "uuid": "e1de836e-7ed6-496d-967c-c574c02fa021", "cycle_start": "2020-01-16", "selection_end": "2020-01-18", "feedback_start": "2020-01-19", "cycle_end": "2020-01-21", "grace_period_end": "2021-01-31", "enable_anytime_nomination": true}], "created": 1579043174.0, "updated": 1591862820.0, "created_on": "2020-01-14T23:06:14.732630Z", "modified_on": "2021-07-15T06:21:58.681106Z", "questions_locked": false, "questions": [{"id": 41, "uuid": "cd617ecd-9e56-4151-99c0-5d0b261d89de", "template_id": 96, "type": "text", "text": "<Question Text>", "options": null, "hide_numbers": false, "order": 0, "mandatory": true}, {"id": 42, "uuid": "afd0bfd5-217f-4a13-ab83-6443effe85af", "template_id": 96, "type": "multiple_choice", "text": "<Question Text>", "options": ["<Option One>", "<Option Two>", "<Option Three>"], "hide_numbers": false, "order": 1, "mandatory": true}, {"id": 43, "uuid": "6ed8d302-700d-48d2-90d1-5793fd1f117b", "template_id": 96, "type": "rating", "text": "<Question Text>", "options": [1, 2, 3], "hide_numbers": false, "order": 2, "mandatory": true}], "allowed_employees": [{"name": "<First Name> <Last Name>", "id": 1, "uuid": "ca3c10c3-7c3c-4d69-9f56-f2511d17bd1e"}, {"name": "<First Name> <Last Name>", "id": 2, "uuid": "c9895fac-69f9-41ee-832d-e9f1c18ef422"}], "allowed_providers": [{"name": "<First Name> <Last Name>", "id": 3, "uuid": "245fdc59-bfe9-464e-9763-44cd71f324ca"}, {"name": "<First Name> <Last Name>", "id": 4, "uuid": "c9f9f8e1-f8c8-4f0e-b9c6-f8f8f8f8f8f8"}], "notify_cycle_started": true, "notify_feedback_reminder": false, "notify_feedback_requested": true, "employee_can_choose": true, "employee_can_view": true, "employee_see_identity": true, "manager_can_choose": true, "manager_can_view": true, "manager_see_identity": true, "skip_level_can_view": false, "skip_level_see_identity": false, "skip_level_managers_level": "none", "default_provider_type": "classic_360", "default_providers_limit": 6, "default_providers_includes_manager": true, "default_providers_includes_directs": true, "default_providers_includes_peers": true, "summary_visible_employee": true, "summary_visible_manager": true, "hold_feedback": false}], "more": true, "nextUrl": "/api/v1/feedback/templates/?size=1&page=2"}, "summary": "Example success response", "description": "List of feedback templates"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid feedback_template_id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/feedback/templates/{template_id}/": {"get": {"operationId": "get_feedback_template", "description": "Returns a feedback template.", "summary": "Get a feedback template", "parameters": [{"in": "path", "name": "template_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The feedback template ID", "required": true}], "tags": ["Feedback"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Feedback_Template_Full"}, "examples": {"ExampleSuccessResponse": {"value": {"id": 96, "uuid": "3a5c9865-ea2b-4726-ae78-9e613a089536", "type": "scheduled", "name": "<Feedback Name>", "enabled": false, "cycles": [{"id": 95, "uuid": "e1de836e-7ed6-496d-967c-c574c02fa021", "cycle_start": "2020-01-16", "selection_end": "2020-01-18", "feedback_start": "2020-01-19", "cycle_end": "2020-01-21", "grace_period_end": "2021-01-31", "enable_anytime_nomination": true}], "created": 1579043174.0, "updated": 1591862820.0, "created_on": "2020-01-14T23:06:14.732630Z", "modified_on": "2021-07-15T06:21:58.681106Z", "questions_locked": false, "questions": [{"id": 41, "uuid": "cd617ecd-9e56-4151-99c0-5d0b261d89de", "template_id": 96, "type": "text", "text": "<Question Text>", "options": null, "hide_numbers": false, "order": 0, "mandatory": true}, {"id": 42, "uuid": "afd0bfd5-217f-4a13-ab83-6443effe85af", "template_id": 96, "type": "multiple_choice", "text": "<Question Text>", "options": ["<Option One>", "<Option Two>", "<Option Three>"], "hide_numbers": false, "order": 1, "mandatory": true}, {"id": 43, "uuid": "6ed8d302-700d-48d2-90d1-5793fd1f117b", "template_id": 96, "type": "rating", "text": "<Question Text>", "options": [1, 2, 3], "hide_numbers": false, "order": 2, "mandatory": true}], "allowed_employees": [{"name": "<First Name> <Last Name>", "id": 1, "uuid": "ca3c10c3-7c3c-4d69-9f56-f2511d17bd1e"}, {"name": "<First Name> <Last Name>", "id": 2, "uuid": "c9895fac-69f9-41ee-832d-e9f1c18ef422"}], "allowed_providers": [{"name": "<First Name> <Last Name>", "id": 3, "uuid": "245fdc59-bfe9-464e-9763-44cd71f324ca"}, {"name": "<First Name> <Last Name>", "id": 4, "uuid": "c9f9f8e1-f8c8-4f0e-b9c6-f8f8f8f8f8f8"}], "notify_cycle_started": true, "notify_feedback_reminder": false, "notify_feedback_requested": true, "employee_can_choose": true, "employee_can_view": true, "employee_see_identity": true, "manager_can_choose": true, "manager_can_view": true, "manager_see_identity": true, "skip_level_can_view": false, "skip_level_see_identity": false, "skip_level_managers_level": "none", "default_provider_type": "classic_360", "default_providers_limit": 6, "default_providers_includes_manager": true, "default_providers_includes_directs": true, "default_providers_includes_peers": true, "summary_visible_employee": true, "summary_visible_manager": true, "hold_feedback": false}, "summary": "Example success response", "description": "Feedback template details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid feedback_template_id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "404": {"content": {"text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}}, "/api/v1/feedback/templates/{template_id}/employees": {"get": {"operationId": "list_feedback_template_employees", "description": "Returns a list of employees associated with a feedback template.", "summary": "Get a list of employees", "parameters": [{"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}, {"in": "path", "name": "template_id", "schema": {"type": "integer"}, "description": "The feedback template ID", "required": true}], "tags": ["Feedback"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Feedback_Template_Employees_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"name": "First Name", "id": 3, "uuid": "245fdc59-bfe9-464e-9763-44cd71f324ca"}], "more": true, "nextUrl": "/api/v1/feedback/templates/?size=1&page=2"}, "summary": "Example success response", "description": "List of feedback template employees"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid feedback_template_id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/feedback/templates/{template_id}/providers": {"get": {"operationId": "list_feedback_template_providers", "description": "Returns a list of providers associated with a feedback template.", "summary": "Get a list of providers", "parameters": [{"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}, {"in": "path", "name": "template_id", "schema": {"type": "integer"}, "description": "The feedback template ID", "required": true}], "tags": ["Feedback"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Feedback_Template_Providers_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"name": "First Name", "id": 3, "uuid": "245fdc59-bfe9-464e-9763-44cd71f324ca"}], "more": true, "nextUrl": "/api/v1/feedback/templates/?size=1&page=2"}, "summary": "Example success response", "description": "List of feedback template providers"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid feedback_template_id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/goals/": {"post": {"operationId": "create_goal", "description": "Returns the created goal.\n            <div style=\"padding: 10px; background: #f0f8ff; width: fit-content; border-radius: 10px;\">\n                <strong>Goal create rules when goal lock enabled:</strong><br/>\n                <span>When </span><strong>Lock Create/Delete/Edit</strong><span> is enabled, it applies to previous and/or current business period goals. When </span><strong>Lock Progress Updates</strong><span> is enabled, it only applies to previous business period goals.</span>\n                <ul>\n                    <li><strong>User</strong> can not create a goal</li>\n                    <li><strong>Manager</strong> can not create a goal</li>\n                    <li><strong>Admin</strong> can create a goal</li>\n                    <li><strong>HR Admin</strong> can not create a goal</li>\n                    <li><strong>Super Admin</strong> can create a goal</li>\n                </ul>\n            </div>", "summary": "Create a goal", "tags": ["Goals and Milestones"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["name", "owner", "start", "end", "visibility", "creation_source", "type"], "properties": {"name": {"type": "string", "example": "Improve Customer Satisfaction"}, "start": {"type": "string", "format": "date", "example": "2020-01-01"}, "end": {"type": "string", "format": "date", "example": "2020-12-31"}, "attribute_scope": {"type": "string", "enum": ["business", "personal", "developmental"]}, "attribute_type": {"type": "string", "enum": ["committed", "aspirational"]}, "parent": {"type": "string", "format": "uuid", "example": "646d0cbd-f47c-4d14-a6d0-cb9c62b4c68c"}, "description": {"type": "string", "example": "Increase customer satisfaction by 10%."}, "owner": {"type": "object", "properties": {"user_id": {"type": "string", "format": "uuid", "example": "8277ffa7-6e30-4989-8ac2-963160a45e43"}}}, "categories": {"type": "array", "items": {"type": "string"}, "example": ["123", "456"]}, "visibility": {"type": "string", "enum": ["public", "locked", "private"]}, "creation_source": {"type": "string", "enum": ["manual", "converted", "default"], "description": "Indicates how the goal was created.\n                        - 'manual' is used when a goal is created directly,\n                        similar to creating a goal normally through the UI.\n                        - 'converted' is used when a Key Result (KR) is\n                        converted into an orphan or standalone goal.\n                        - 'default' is used for system-generated goals,\n                        such as \"Getting Started with Betterworks\" etc."}, "type": {"type": "string", "enum": ["avgofprogress", "sumofcurrent", "sumofrange", "manualprogress"]}, "key_results": {"type": "array", "title": "KeyResult", "items": {"type": "object", "required": ["name", "owner", "type", "target"], "properties": {"name": {"type": "string", "example": "Provide 24/7 customer support"}, "start": {"type": "string", "format": "date", "example": "2020-01-01"}, "end": {"type": "string", "format": "date", "example": "2020-12-31"}, "attribute_scope": {"type": "string", "enum": ["business", "personal", "developmental"]}, "attribute_type": {"type": "string", "enum": ["committed", "aspirational"]}, "id": {"type": "string", "example": "646d0cbd-f47c-4d14-a6d0-cb9c62b4c68c"}, "owner": {"type": "object", "properties": {"user_id": {"type": "string", "example": "8277ffa7-6e30-4989-8ac2-963160a45e43"}}}, "type": {"type": "string", "enum": ["numeric", "binary", "range"]}, "target": {"type": "number", "example": 100.0}, "unit": {"type": "string", "example": "Percent"}, "auto_target": {"type": "boolean"}, "initial": {"type": "number", "example": 0.0}, "lower_limit": {"type": "number", "example": 1.0}, "lower_mid": {"type": "number", "example": 25.0}, "upper_limit": {"type": "number", "example": 110.0}, "upper_mid": {"type": "number", "example": 105.0}}}}, "auto_target": {"type": "boolean"}, "initial": {"type": "number", "example": 0.0}, "target": {"type": "number", "example": 100.0}, "unit": {"type": "string", "example": "Percent"}, "lower_limit": {"type": "number", "example": 1.0}, "lower_mid": {"type": "number", "example": 25.0}, "upper_limit": {"type": "number", "example": 110.0}, "upper_mid": {"type": "number", "example": 105.0}}}}}}, "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Goal"}, "examples": {"ExampleSuccessResponse": {"value": {"description": "<Goal Description>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Goal Name>", "is_key_result": true, "is_shared_with_downline": false, "end": "2023-01-04", "start": "2023-01-04", "measurement": {"progress": 1.0, "initial": 0.0, "target": 100.0, "unit": "Percent", "done": true, "lower_limit": 1.0, "lower_mid": 25.0, "upper_limit": 110.0, "upper_mid": 105.0, "current": 78.4, "type": "avgofprogress", "expected": 1.0, "condition": "green", "is_binary": true, "is_numeric": true}, "owner": {"user": {"name": "<First Name> <Last Name>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "group": {"id": 333, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Group Name>", "parent_id": 123, "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "is_team": true}, "team": {"id": 12, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Team Name>", "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}}, "parent": {"name": "<Parent Goal Name>", "id": 1223, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "children": [{"name": "<Child Goal Name>", "id": 44, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "modified_on": "2023-01-04T21:47:26.624Z"}], "updated_by": {"name": "<First Name> <Last Name>", "id": 23, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "visibility": "public", "integration": {"type": "salesforce", "last_sync": 0, "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "stats": {"comments": 0, "cheers": 0, "nudges": 0, "views": 0, "last_assessed": 0}, "categories": [{"name": "<Category Name>", "id": 11, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "attribute_type": "Committed", "attribute_scope": "Business", "created": 1453420800.0, "created_by": {"name": "<First Name> <Last Name>", "id": 233, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "last_checkedin": 1467115788.350479, "last_checkedin_by": {"name": "<First Name> <Last Name>", "id": 111, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}, "summary": "Example success response", "description": "Goal details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/goals/{goal_id}/": {"get": {"operationId": "get_goal", "description": "Returns a goal.", "summary": "Get a goal", "parameters": [{"in": "path", "name": "goal_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The goal ID", "required": true}], "tags": ["Goals and Milestones"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Goal"}, "examples": {"ExampleSuccessResponse": {"value": {"description": "<Goal Description>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Goal Name>", "is_key_result": true, "is_shared_with_downline": false, "end": "2023-01-04", "start": "2023-01-04", "measurement": {"progress": 1.0, "initial": 0.0, "target": 100.0, "unit": "Percent", "done": true, "lower_limit": 1.0, "lower_mid": 25.0, "upper_limit": 110.0, "upper_mid": 105.0, "current": 78.4, "type": "avgofprogress", "expected": 1.0, "condition": "green", "is_binary": true, "is_numeric": true}, "owner": {"user": {"name": "<First Name> <Last Name>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "group": {"id": 333, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Group Name>", "parent_id": 123, "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "is_team": true}, "team": {"id": 12, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Team Name>", "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}}, "parent": {"name": "<Parent Goal Name>", "id": 1223, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "children": [{"name": "<Child Goal Name>", "id": 44, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "modified_on": "2023-01-04T21:47:26.624Z"}], "updated_by": {"name": "<First Name> <Last Name>", "id": 23, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "visibility": "public", "integration": {"type": "salesforce", "last_sync": 0, "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "stats": {"comments": 0, "cheers": 0, "nudges": 0, "views": 0, "last_assessed": 0}, "categories": [{"name": "<Category Name>", "id": 11, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "attribute_type": "Committed", "attribute_scope": "Business", "created": 1453420800.0, "created_by": {"name": "<First Name> <Last Name>", "id": 233, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "last_checkedin": 1467115788.350479, "last_checkedin_by": {"name": "<First Name> <Last Name>", "id": 111, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}, "summary": "Example success response", "description": "Goal details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid goal id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "404": {"content": {"text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}, "put": {"operationId": "update_goal", "description": "Returns the updated goal..\n            <div style=\"padding: 10px; background: #f0f8ff; width: fit-content; border-radius: 10px;\">\n                <strong>Goal update rules when goal lock enabled:</strong><br/>\n                <span>When </span><strong>Lock Create/Delete/Edit</strong><span> is enabled, it applies to previous and/or current business period goals. When </span><strong>Lock Progress Updates</strong><span> is enabled, it only applies to previous business period goals.</span>\n                <ul>\n                    <li><strong>User</strong> can update only certain fields</li>\n                    <li><strong>Manager</strong> can update only certain fields</li>\n                    <li><strong>Admin</strong> can update all fields</li>\n                    <li><strong>HR Admin</strong> can update only certain fields</li>\n                    <li><strong>Super Admin</strong> can update all fields</li>\n                </ul>\n            </div>", "summary": "Update a goal", "parameters": [{"in": "path", "name": "goal_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The ID of the goal to be updated", "required": true}], "tags": ["Goals and Milestones"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "properties": {"name": {"type": "string", "example": "Improve Customer Satisfaction"}, "start": {"type": "string", "format": "date", "example": "2020-01-01"}, "end": {"type": "string", "format": "date", "example": "2020-12-31"}, "attribute_scope": {"type": "string", "enum": ["business", "personal", "developmental"]}, "attribute_type": {"type": "string", "enum": ["committed", "aspirational"]}, "parent": {"type": "string", "format": "uuid", "example": "646d0cbd-f47c-4d14-a6d0-cb9c62b4c68c"}, "description": {"type": "string", "example": "<Goal Description>"}, "owner": {"type": "object", "properties": {"user_id": {"type": "string", "format": "uuid", "example": "8277ffa7-6e30-4989-8ac2-963160a45e43"}}}, "visibility": {"type": "string", "enum": ["public", "locked", "private"], "example": "public"}, "key_results": {"type": "array", "title": "KeyResult", "items": {"type": "object", "properties": {"name": {"type": "string", "example": "Improve Customer Satisfaction"}, "start": {"type": "string", "format": "date", "example": "2020-01-01"}, "end": {"type": "string", "format": "date", "example": "2020-12-31"}, "attribute_scope": {"type": "string", "enum": ["business", "personal", "developmental"]}, "attribute_type": {"type": "string", "enum": ["committed", "aspirational"]}, "delete": {"type": "boolean"}, "create": {"type": "boolean"}, "id": {"type": "string", "example": "e98d4f17-99c5-418a-ac70-f1fe27c739f7"}, "owner": {"type": "object", "properties": {"user_id": {"type": "string", "example": "8277ffa7-6e30-4989-8ac2-963160a45e43"}}}, "auto_target": {"type": "boolean"}, "type": {"type": "string", "enum": ["binary", "numeric", "range"]}, "initial": {"type": "number", "example": 0.0}, "target": {"type": "number", "example": 100.0}, "unit": {"type": "string", "example": "Percent"}, "lower_limit": {"type": "number", "example": 1.0}, "lower_mid": {"type": "number", "example": 25.0}, "upper_limit": {"type": "number", "example": 110.0}, "upper_mid": {"type": "number", "example": 105.0}}}}, "auto_target": {"type": "boolean"}, "initial": {"type": "number", "example": 0.0}, "target": {"type": "number", "example": 100.0}, "unit": {"type": "string", "example": "Percent"}, "lower_limit": {"type": "number", "example": 1.0}, "lower_mid": {"type": "number", "example": 25.0}, "upper_limit": {"type": "number", "example": 110.0}, "upper_mid": {"type": "number", "example": 105.0}}}}}}, "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Goal"}, "examples": {"ExampleSuccessResponse": {"value": {"description": "<Goal Description>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Goal Name>", "is_key_result": true, "is_shared_with_downline": false, "end": "2023-01-04", "start": "2023-01-04", "measurement": {"progress": 1.0, "initial": 0.0, "target": 100.0, "unit": "Percent", "done": true, "lower_limit": 1.0, "lower_mid": 25.0, "upper_limit": 110.0, "upper_mid": 105.0, "current": 78.4, "type": "avgofprogress", "expected": 1.0, "condition": "green", "is_binary": true, "is_numeric": true}, "owner": {"user": {"name": "<First Name> <Last Name>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "group": {"id": 333, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Group Name>", "parent_id": 123, "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "is_team": true}, "team": {"id": 12, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Team Name>", "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}}, "parent": {"name": "<Parent Goal Name>", "id": 1223, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "children": [{"name": "<Child Goal Name>", "id": 44, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "modified_on": "2023-01-04T21:47:26.624Z"}], "updated_by": {"name": "<First Name> <Last Name>", "id": 23, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "visibility": "public", "integration": {"type": "salesforce", "last_sync": 0, "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "stats": {"comments": 0, "cheers": 0, "nudges": 0, "views": 0, "last_assessed": 0}, "categories": [{"name": "<Category Name>", "id": 11, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "attribute_type": "Committed", "attribute_scope": "Business", "created": 1453420800.0, "created_by": {"name": "<First Name> <Last Name>", "id": 233, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "last_checkedin": 1467115788.350479, "last_checkedin_by": {"name": "<First Name> <Last Name>", "id": 111, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}, "summary": "Example success response", "description": "Goal details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid goal id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "404": {"content": {"text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}, "delete": {"operationId": "delete_goal", "description": "Returns a 200 response.\n            <div style=\"padding: 10px; background: #f0f8ff; width: fit-content; border-radius: 10px;\">\n                <div>\n                    <strong>Goal deletion rules:</strong>\n                    <ul>\n                        <li><strong>User</strong> can delete own goals only</li>\n                        <li><strong>Manager</strong> can delete own goals and goals of managed users</li>\n                        <li><strong>Admin</strong> can delete all goals</li>\n                        <li><strong>HR Admin</strong> can delete own goals only</li>\n                        <li><strong>Super Admin</strong> can delete all goals</li>\n                    </ul>\n                </div>\n                <div>\n                    <strong>Goal deletion rules when goal lock enabled:</strong><br/>\n                    <span>When </span><strong>Lock Create/Delete/Edit</strong><span> is enabled, it applies to previous and/or current business period goals. When </span><strong>Lock Progress Updates</strong><span> is enabled, it only applies to previous business period goals.</span>\n                    <ul>\n                        <li><strong>User</strong> cannot delete goals</li>\n                        <li><strong>Manager</strong> cannot delete goals</li>\n                        <li><strong>Admin</strong> can delete all goals</li>\n                        <li><strong>HR Admin</strong> cannot delete goals</li>\n                        <li><strong>Super Admin</strong> can delete all goals</li>\n                    </ul>\n                </div>\n            </div>", "summary": "Delete a goal", "parameters": [{"in": "path", "name": "goal_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The ID of the goal to be deleted", "required": true}], "tags": ["Goals and Milestones"], "security": [{"API_Public_Token": []}], "responses": {"200": {"description": "Successful response"}, "204": {"description": "No Content"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid goal id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "404": {"content": {"text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}}, "/api/v1/goals/{goal_id}/assessments/": {"get": {"operationId": "list_goal_assessments", "description": "Returns a list of assessments.", "summary": "Get a list of assessments", "parameters": [{"in": "path", "name": "goal_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The ID of the goal associated with the assessments", "required": true}], "tags": ["Goals and Milestones"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/Goal_Assessment"}}, "examples": {"ExampleSuccessResponse": {"value": [{"id": 123, "uuid": "c30bef26-afd5-4233-abaa-a2318ed65bf2", "created": 1667941512.025881, "edited": 1667941512.025881, "created_by": {"name": "<First Name> <Last Name>", "id": 123456, "uuid": "ca3c10c3-7c3c-4d69-9f56-f2511d17bd1e"}, "goal_id": 123, "comment": "<Comment Text>", "score": 0.5}], "summary": "Example success response", "description": "Goal assessment details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid goal id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "404": {"content": {"text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}}, "/api/v1/goals/{goal_id}/checkin/": {"post": {"operationId": "post_goal_checkin", "description": "Returns the goal associated with the check in\n            of a milestone. Returns the parent goal updated with the new information.\n            <div style=\"padding: 10px; background: #f0f8ff; width: fit-content; border-radius: 10px;\">\n                <div>\n                    <strong>Milestone check in rules when goal lock enabled:</strong><br/>\n                    <span>When </span><strong>Lock Progress Updates</strong><span> is enabled, it only applies to previous business period goals.</span>\n                    <ul>\n                        <li><strong>User</strong> cannot conduct a check in</li>\n                        <li><strong>Manager</strong> cannot conduct a check in</li>\n                        <li><strong>Admin</strong> can conduct a check in</li>\n                        <li><strong>HR Admin</strong> cannot conduct a check in</li>\n                        <li><strong>Super Admin</strong> can conduct a check in</li>\n                    </ul>\n                </div>\n            </div>", "summary": "Conduct a goal check in", "parameters": [{"in": "path", "name": "goal_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The ID of the goal or milestone to perform the check in on. You cannot directly update the value of a goal if it has milestones (progress is derived from contributing milestones).", "required": true}], "tags": ["Goals and Milestones"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["done", "value"], "properties": {"done": {"type": "boolean", "description": "New completion state for the binary milestone"}, "value": {"type": "number", "description": "New current progress on the metric milestone", "example": 0.5}, "target": {"type": "number", "description": "New target value for the milestone (metric milestone only)", "example": 0.5}}}}}}, "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Goal"}, "examples": {"ExampleSuccessResponse": {"value": {"description": "<Goal Description>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Goal Name>", "is_key_result": true, "is_shared_with_downline": false, "end": "2023-01-04", "start": "2023-01-04", "measurement": {"progress": 1.0, "initial": 0.0, "target": 100.0, "unit": "Percent", "done": true, "lower_limit": 1.0, "lower_mid": 25.0, "upper_limit": 110.0, "upper_mid": 105.0, "current": 78.4, "type": "avgofprogress", "expected": 1.0, "condition": "green", "is_binary": true, "is_numeric": true}, "owner": {"user": {"name": "<First Name> <Last Name>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "group": {"id": 333, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Group Name>", "parent_id": 123, "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "is_team": true}, "team": {"id": 12, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Team Name>", "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}}, "parent": {"name": "<Parent Goal Name>", "id": 1223, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "children": [{"name": "<Child Goal Name>", "id": 44, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "modified_on": "2023-01-04T21:47:26.624Z"}], "updated_by": {"name": "<First Name> <Last Name>", "id": 23, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "visibility": "public", "integration": {"type": "salesforce", "last_sync": 0, "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "stats": {"comments": 0, "cheers": 0, "nudges": 0, "views": 0, "last_assessed": 0}, "categories": [{"name": "<Category Name>", "id": 11, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "attribute_type": "Committed", "attribute_scope": "Business", "created": 1453420800.0, "created_by": {"name": "<First Name> <Last Name>", "id": 233, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "last_checkedin": 1467115788.350479, "last_checkedin_by": {"name": "<First Name> <Last Name>", "id": 111, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}, "summary": "Example success response", "description": "Goal details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid goal id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "404": {"content": {"text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}}, "/api/v1/goals/{goal_id}/comments/": {"get": {"operationId": "list_goal_comments", "description": "Returns a list of goal comments.", "summary": "Get a list of goal comments", "parameters": [{"in": "path", "name": "goal_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "The goal ID associated with the comments", "required": true}], "tags": ["Goals and Milestones"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Goal_Comment_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 123, "uuid": "c30bef26-afd5-4233-abaa-a2318ed65bf2", "created": 1667941512.025881, "edited": 1667941512.025881, "created_on": "2023-01-04T21:01:51.878Z", "modified_on": "2023-01-04T21:01:51.878Z", "text": "<Comment Text>", "author": {"name": "<First Name> <Last Name>", "id": 123456, "uuid": "ca3c10c3-7c3c-4d69-9f56-f2511d17bd1e"}, "goal": {"name": "<Goal Name>", "id": 123, "uuid": "ca3c10c3-7c3c-4d69-9f56-f2511d17bd1e"}, "goal_owner": {"user": {"name": "<First Name> <Last Name>", "id": 123456, "uuid": "ca3c10c3-7c3c-4d69-9f56-f2511d17bd1e"}}, "is_key_result": false}], "more": true, "nextUrl": "/api/v1/goals/:goal_id/comments/?size=10&page=2"}, "summary": "Example success response", "description": "List of goal comments"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid goal id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "404": {"content": {"text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}}, "/api/v1/goals/categories/search/": {"get": {"operationId": "list_goal_categories_by_name", "description": "Returns a list of all goal categories matching the search criteria.\n            <strong>Matches on goal category name</strong>.", "summary": "Search for goal categories", "parameters": [{"in": "query", "name": "q", "schema": {"type": "string"}, "description": "Query string matching goal category name"}], "tags": ["Goals and Milestones"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Goal_Category_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 75, "name": "<Goal Category Name>", "updated": 1561154848.895091, "updated_by_id": 529, "created": 1561154848.895091, "created_by_id": 529}], "more": true, "nextUrl": "/api/v1/goals/categories/search/?size=10&page=2"}, "summary": "Example success response", "description": "List of returned goal categories"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/goals/filter/": {"get": {"operationId": "list_goals_by_filter", "description": "Returns a list of goals matching the filter criteria.", "summary": "Get a filtered list of goals", "parameters": [{"in": "query", "name": "aligned_to_goal", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "Filter goals aligned to the specified goal ID"}, {"in": "query", "name": "aligned_to_owner", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "Filter goals aligned to the specified owner ID"}, {"in": "query", "name": "assessment", "schema": {"type": "string", "enum": ["no", "yes"]}, "description": "Filter goals that have been assessed"}, {"in": "query", "name": "category", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "Filter goals by the specified category ID"}, {"in": "query", "name": "date_range", "schema": {"type": "string"}, "description": "Filter for goals that are active during the specified date range,\n                formatted as `MM/DD/YYYY-MM/DD/YYYY`"}, {"in": "query", "name": "delta_end", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or before the given date\n            - example: `2021-12-31T23:59:59Z`\n        "}, {"in": "query", "name": "delta_start", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or after the given date\n            - example: `2020-01-01T00:00:00Z`\n        "}, {"in": "query", "name": "following", "schema": {"type": "string", "enum": ["no", "yes"]}, "description": "Filters goals that the current user is following\n                (no will filter out any followed goals)"}, {"in": "query", "name": "group", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "Filters goals in the specified group (department) by ID"}, {"in": "query", "name": "integration", "schema": {"type": "string", "enum": ["jira", "salesforce", "tableau"]}, "description": "Filters for goals using specific integrations"}, {"in": "query", "name": "owner", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "Filter goals owned by the specified user ID"}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "permission", "schema": {"type": "string", "enum": ["can_edit", "can_only_view"]}, "description": "Filters goals that the current user can_edit or can_only_view"}, {"in": "query", "name": "reports_to", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}]}, "description": "Filters goals owned by users who report to the specified manager"}, {"in": "query", "name": "risk", "schema": {"type": "string", "enum": ["atrisk", "needsattention", "ontrack"]}, "description": "Filters goals that the current user is following\n                (no will filter out any followed goals)"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}, {"in": "query", "name": "team_only", "schema": {"type": "string", "enum": ["no", "yes"]}, "description": "Filter goals owned by users on your team\n                (no will filter out any goals owned by your team)"}, {"in": "query", "name": "top_company_goal", "schema": {"type": "string", "enum": ["no", "yes"]}, "description": "Filters for top company goals\n                (\"no\" will filter out any top company goals)"}, {"in": "query", "name": "unit", "schema": {"type": "string"}, "description": "Filters for goals with units in their milestones\n                - example: `percent`"}, {"in": "query", "name": "updated_since", "schema": {"type": "string"}, "description": "Filter for key results that have been updated since the date,\n                formatted as `MM/DD/YYYY-MM/DD/YYYY`"}, {"in": "query", "name": "viewed_by_owner_date", "schema": {"type": "string"}, "description": "Filter goals owned by the current user that they viewed within the\n                specified date range, formatted as `MM/DD/YYYY-MM/DD/YYYY`"}, {"in": "query", "name": "visibility", "schema": {"type": "string", "enum": ["private", "public"]}, "description": "Filter goals by visibility, accepts public or private"}], "tags": ["Goals and Milestones"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Goal_Filter_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"description": "<Goal Description>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Goal Name>", "is_key_result": true, "is_shared_with_downline": false, "end": "2023-01-04", "start": "2023-01-04", "measurement": {"progress": 1.0, "initial": 0.0, "target": 100.0, "unit": "Percent", "done": true, "lower_limit": 1.0, "lower_mid": 25.0, "upper_limit": 110.0, "upper_mid": 105.0, "current": 78.4, "type": "avgofprogress", "expected": 1.0, "condition": "green", "is_binary": true, "is_numeric": true}, "owner": {"user": {"name": "<First Name> <Last Name>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "group": {"id": 333, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Group Name>", "parent_id": 123, "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "is_team": true}, "team": {"id": 12, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Team Name>", "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}}, "parent": {"name": "<Parent Goal Name>", "id": 1223, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "children": [{"name": "<Child Goal Name>", "id": 44, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "modified_on": "2023-01-04T21:47:26.624Z"}], "updated_by": {"name": "<First Name> <Last Name>", "id": 23, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "visibility": "public", "integration": {"type": "salesforce", "last_sync": 0, "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "stats": {"comments": 0, "cheers": 0, "nudges": 0, "views": 0, "last_assessed": 0}, "categories": [{"name": "<Category Name>", "id": 11, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "attribute_type": "Committed", "attribute_scope": "Business", "created": 1453420800.0, "created_by": {"name": "<First Name> <Last Name>", "id": 233, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "last_checkedin": 1467115788.350479, "last_checkedin_by": {"name": "<First Name> <Last Name>", "id": 111, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z", "contributors": [{"id": 2, "name": "<First Name> <Last Name>", "is_active": false}]}], "more": true, "nextUrl": "/api/v1/goals/filter?size=10&page=2"}, "summary": "Example success response", "description": "List of filtered goals"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid owner ids", "Invalid value: <value>, criteria type: 3 (bad value type: <class \"str\">)"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/goals/search/": {"get": {"operationId": "list_goals_by_name", "description": "Returns a list of all goals matching the search criteria.\n            Matches on goal name.", "summary": "Search for goals", "parameters": [{"in": "query", "name": "current", "schema": {"type": "boolean"}, "description": "Search for goals that are currently active"}, {"in": "query", "name": "current_stale", "schema": {"type": "boolean"}, "description": "Search for goals that are current or have expired within 7 days"}, {"in": "query", "name": "future", "schema": {"type": "boolean"}, "description": "Search for goals that have yet to start"}, {"in": "query", "name": "goal_type", "schema": {"type": "string", "enum": ["avgofprogress", "sumofcurrent", "sumofrange"]}, "description": "Search for goals by type"}, {"in": "query", "name": "not_due", "schema": {"type": "boolean"}, "description": "Search for goals that have not yet ended"}, {"in": "query", "name": "q", "schema": {"type": "string"}, "description": "Search for goals by name", "required": true}, {"in": "query", "name": "visibility", "schema": {"type": "string", "enum": ["locked", "private", "public"]}, "description": "Search for goals that are public or private"}], "tags": ["Goals and Milestones"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Goal_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"description": "<Goal Description>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Goal Name>", "is_key_result": true, "is_shared_with_downline": false, "end": "2023-01-04", "start": "2023-01-04", "measurement": {"progress": 1.0, "initial": 0.0, "target": 100.0, "unit": "Percent", "done": true, "lower_limit": 1.0, "lower_mid": 25.0, "upper_limit": 110.0, "upper_mid": 105.0, "current": 78.4, "type": "avgofprogress", "expected": 1.0, "condition": "green", "is_binary": true, "is_numeric": true}, "owner": {"user": {"name": "<First Name> <Last Name>", "id": 123, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "group": {"id": 333, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Group Name>", "parent_id": 123, "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "is_team": true}, "team": {"id": 12, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "<Team Name>", "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}}, "parent": {"name": "<Parent Goal Name>", "id": 1223, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "children": [{"name": "<Child Goal Name>", "id": 44, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "modified_on": "2023-01-04T21:47:26.624Z"}], "updated_by": {"name": "<First Name> <Last Name>", "id": 23, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "visibility": "public", "integration": {"type": "salesforce", "last_sync": 0, "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "stats": {"comments": 0, "cheers": 0, "nudges": 0, "views": 0, "last_assessed": 0}, "categories": [{"name": "<Category Name>", "id": 11, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "attribute_type": "Committed", "attribute_scope": "Business", "created": 1453420800.0, "created_by": {"name": "<First Name> <Last Name>", "id": 233, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "last_checkedin": 1467115788.350479, "last_checkedin_by": {"name": "<First Name> <Last Name>", "id": 111, "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "created_on": "2023-01-04T21:47:26.624Z", "modified_on": "2023-01-04T21:47:26.624Z"}], "more": true, "nextUrl": "/api/v1/goals?size=10&page=2"}, "summary": "Example success response", "description": "List of goals"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["query parameter <q> is required", "goal search requires <q> to have a minimum length of 3"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/groups/": {"get": {"operationId": "list_admin_groups", "description": "Returns a list of admin groups.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Get a list of admin groups", "parameters": [{"in": "query", "name": "delta_end", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or before the given date\n            - example: `2021-12-31T23:59:59Z`\n        "}, {"in": "query", "name": "delta_start", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or after the given date\n            - example: `2020-01-01T00:00:00Z`\n        "}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}], "tags": ["Admin Groups"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Admin_Groups_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 123, "uuid": "e98d4f17-99c5-418a-ac70-f1fe27c739f7", "name": "<Admin Group Name>", "is_active": true, "template_usage": true, "last_edited": 1601361643.726711, "last_edited_by": {"id": 45, "uuid": "12ebee06-2595-4471-976a-01321f3de805", "name": "<First Name> <Last Name>"}, "member_count": 2, "attributes": [{"operation": "include", "property": "department", "value": [{"id": 332, "uuid": "f6575647-045f-4273-977b-2df7b437ba5d", "name": "<Department Name>", "parent_id": 564, "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "is_team": false}]}], "additional_members": [{"id": 28, "uuid": "da198a06-fd5e-4b22-a2dd-88e604e5ac05", "name": "<First Name> <Last Name>"}], "created_on": "2022-01-18T18:43:01.859716Z", "modified_on": "2022-01-18T18:43:01.859791Z"}], "more": true, "nextUrl": "/api/v1/groups/?size=1&page=2"}, "summary": "Example success response", "description": "List of admin groups"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}}, "/api/v1/groups/{admin_group_id}/": {"get": {"operationId": "get_admin_group", "description": "Returns an admin group.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Get an admin group", "parameters": [{"in": "path", "name": "admin_group_id", "schema": {"type": "integer"}, "description": "The admin group ID", "required": true}], "tags": ["Admin Groups"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Admin_Group"}, "examples": {"ExampleSuccessResponse": {"value": {"id": 123, "uuid": "e98d4f17-99c5-418a-ac70-f1fe27c739f7", "name": "<Admin Group Name>", "is_active": true, "template_usage": true, "last_edited": 1601361643.726711, "last_edited_by": {"id": 45, "uuid": "12ebee06-2595-4471-976a-01321f3de805", "name": "<First Name> <Last Name>"}, "member_count": 2, "attributes": [{"operation": "include", "property": "department", "value": [{"id": 332, "uuid": "f6575647-045f-4273-977b-2df7b437ba5d", "name": "<Department Name>", "parent_id": 564, "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "is_team": false}]}], "additional_members": [{"id": 28, "uuid": "da198a06-fd5e-4b22-a2dd-88e604e5ac05", "name": "<First Name> <Last Name>"}], "created_on": "2022-01-18T18:43:01.859716Z", "modified_on": "2022-01-18T18:43:01.859791Z"}, "summary": "Example success response", "description": "Admin group details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid admin_group_id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}}, "/api/v1/hashtags/": {"get": {"operationId": "list_hashtags", "description": "Returns a list of hashtags.", "summary": "Get a list of hashtags", "parameters": [{"in": "query", "name": "delta_end", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or before the given date\n            - example: `2021-12-31T23:59:59Z`\n        "}, {"in": "query", "name": "delta_start", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or after the given date\n            - example: `2020-01-01T00:00:00Z`\n        "}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}], "tags": ["Hashtags"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Hashtags_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"name": "Success", "id": 1, "created_on": "2022-01-25T06:34:42.581663Z", "modified_on": "2022-01-25T06:34:42.581733Z"}], "more": "true", "nextUrl": "/api/v1/hashtags/?size=2&page=2"}, "summary": "Example success response", "description": "List of hashtags"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/integrations/{integration_id}/": {"get": {"operationId": "get_milestone_integration", "description": "Returns milestone integration details.", "summary": "Get milestone integration details", "parameters": [{"in": "path", "name": "integration_id", "schema": {"type": "string", "format": "uuid"}, "description": "The integration UUID", "required": true}], "tags": ["Integrations"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Integration_Full"}, "examples": {"ExampleSuccessResponse": {"value": {"type": "jira", "items": [{"key": "<Issue Name1>", "summary": "<Issue Description>", "status": "<Issue Status>", "is_resolved": false, "resolution_status": null, "url": "<Issue URL>"}, {"key": "<Issue Name2>", "summary": "<Issue Description>", "status": "<Issue Status>", "is_resolved": true, "resolution_status": null, "url": "<Issue URL>"}]}, "summary": "Example success response", "description": "Integration type and details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid identifier: <integration_id>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/recognitions/": {"get": {"operationId": "list_recognitions", "description": "Returns a list of recognitions.", "summary": "Get a list of recognitions", "parameters": [{"in": "query", "name": "delta_end", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or before the given date\n            - example: `2021-12-31T23:59:59Z`\n        "}, {"in": "query", "name": "delta_start", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or after the given date\n            - example: `2020-01-01T00:00:00Z`\n        "}, {"in": "query", "name": "end_date", "schema": {"type": "string", "format": "date"}, "description": "The ending date in the format `YYYY-MM-DD` - if provided `start_date` is required"}, {"in": "query", "name": "for_group_id", "schema": {"type": "integer"}, "description": "Filters items relative to a given group"}, {"in": "query", "name": "for_user_id", "schema": {"type": "integer"}, "description": "Filters items relative to a given user"}, {"in": "query", "name": "hashtag", "schema": {"type": "string"}, "description": "A hashtag used in a recognition"}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}, {"in": "query", "name": "start_date", "schema": {"type": "string", "format": "date"}, "description": "The starting date in the format `YYYY-MM-DD` - if provided `end_date` is required"}], "tags": ["Recognitions"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Recognitions_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 123, "uuid": "776f543c-3c24-40ed-8c56-3f4bee9f8b9c", "author": {"name": "<First Name> <Last Name>", "id": 456, "uuid": "8ea3652d-d967-4db3-8c31-b356c07d75b2"}, "for_user": {"name": "<First Name> <Last Name>", "id": 789, "uuid": "036635ec-8632-4a2c-8045-6094265094fc"}, "for_group": null, "mentioned_users": [{"name": "<First Name> <Last Name>", "id": 115, "uuid": "cb96dbdc-c996-40ab-9648-2cef1f508998"}], "hashtags": [{"name": "<Hashtag Name>", "id": 766, "uuid": "b3b2b2b2-3c24-40ed-8c56-3f4bee9f8b9c"}], "source": {"comment": {"id": 25645, "uuid": "2870f531-8315-43fd-bab8-3fcf0ad9b2c4", "created": 1669900884.929992, "edited": 1669900884.929992, "created_on": "2022-12-01T13:21:24.940361Z", "modified_on": "2022-12-01T13:21:24.940407Z", "text": "<Comment Text>", "author": {"name": "<First Name> <Last Name>", "id": 3879, "uuid": "282ff2e6-4a97-4c90-b34a-e8f32bc2a8e7"}, "goal": {"name": "<Goal Name>", "id": 9186, "uuid": "3833f275-72c3-4714-b12e-fa33115ec579"}, "goal_owner": {"user": {"name": "<First Name> <Last Name>", "id": 3879, "uuid": "282ff2e6-4a97-4c90-b34a-e8f32bc2a8e7"}, "group": null, "team": {"id": 1536, "uuid": "e9bd60b0-75d1-4c10-adc6-65ac32fcd1db", "name": "<Team Name>", "picture_uris": {"small": "<URL>", "medium": "<URL>"}, "is_active": true, "created_on": "2021-11-10T21:28:29.610217Z", "modified_on": "2021-11-10T21:28:29.610217Z"}}, "is_key_result": false}, "shoutout": {"id": 2456, "uuid": "9f402bfe-d0f0-4b24-a7c1-4cc39e8eca8e", "for_user_id": 789, "for_user_name": "<First Name> <Last Name>", "author_id": 456, "author_name": "<First Name> <Last Name>", "text": "<Shoutout Text>", "created": 1669869833.40859, "edited": 1669870123.40859}}, "created": 1669869833.40859, "created_on": "2022-12-01T04:43:53.469592Z", "modified_on": "2022-12-01T04:43:53.469633Z"}], "more": true, "nextUrl": "/api/v1/recognitions/?size=1&page=2"}, "summary": "Example success response", "description": "List of recognitions"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/report_runs/": {"get": {"operationId": "list_report_runs", "description": "Returns a list of report runs.\n            <strong>This endpoint is only available to users with super admin,\n            HR admin or admin role.</strong>", "summary": "Get a list of report runs", "parameters": [{"in": "query", "name": "created", "schema": {"type": "string"}, "description": "The date the report was created"}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "report", "schema": {"type": "string"}, "description": "The name of the report"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}, {"in": "query", "name": "template", "schema": {"type": "string"}, "description": "The template ID"}], "tags": ["Reports"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Report_Run_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 1000, "report": "<Report Name>", "created": 1617389428.763803, "created_by": {"name": "<First Name> <Last Name>", "id": 22}, "status": "succeeded", "parameters": {"template": 1234, "date_range": {"start": "2021-01-01", "end": "2021-01-31"}}, "finished": 1617389431.097175, "error": null, "result": {"created": 1617389431.096469, "expires_on": 1617475831.09387, "filename": "<File Name>", "type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "url": "<URL>"}}], "more": true, "nextUrl": "/api/v1/report_runs/?size=1&page=2"}, "summary": "Example success response", "description": "List of report runs"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}, "404": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": "item not found"}}}}}, "description": "Not Found"}}}, "post": {"operationId": "create_report_run", "description": "Returns the created report run.\n            <strong>This endpoint is only available to users with super admin,\n            HR admin or admin role.</strong>", "summary": "Create a report run", "tags": ["Reports"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["report", "parameters"], "properties": {"report": {"description": "<strong>NOTE:</strong> the `conversation_answers` and\n                            `feedback_answers` report are only available to users with super\n                            admin or HR admin role", "type": "string", "enum": ["all_goals", "all_goals_and_milestones", "conversation_adoption", "conversation_answers", "feedback_adoption", "feedback_answers", "goal_weights", "recognition", "talent_records", "user_activity"]}, "parameters": {"type": "object", "required": ["date_range"], "properties": {"template": {"type": "integer", "description": "The conversation/feedback template ID of the report - required for conversation and feedback reports", "example": 123}, "date_range": {"type": "object", "required": ["start", "end"], "properties": {"start": {"type": "string", "format": "date", "description": "The start date of the report in the format `YYYY-MM-DD`", "example": "2020-01-01"}, "end": {"type": "string", "format": "date", "description": "The end date of the report in the format `YYYY-MM-DD`", "example": "2020-12-31"}}}}}}}}}}, "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Report_Run"}, "examples": {"ExampleSuccessResponse": {"value": {"id": 1000, "report": "<Report Name>", "created": 1617389428.763803, "created_by": {"name": "<First Name> <Last Name>", "id": 22}, "status": "succeeded", "parameters": {"template": 1234, "date_range": {"start": "2021-01-01", "end": "2021-01-31"}}, "finished": 1617389431.097175, "error": null, "result": {"created": 1617389431.096469, "expires_on": 1617475831.09387, "filename": "<File Name>", "type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "url": "<URL>"}}, "summary": "Example success response", "description": "Report run details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}, "404": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": "item not found"}}}}}, "description": "Not Found"}, "429": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": "Too many report runs"}}}}}, "description": "Locked"}}}}, "/api/v1/report_runs/{report_run_id}/": {"get": {"operationId": "get_report_run", "description": "Returns a report run.\n            <strong>This endpoint is only available to users with super admin,\n            HR admin or admin role.</strong>", "summary": "Get a report run", "parameters": [{"in": "path", "name": "report_run_id", "schema": {"type": "integer"}, "description": "The report run ID", "required": true}], "tags": ["Reports"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Report_Run"}, "examples": {"ExampleSuccessResponse": {"value": {"id": 1000, "report": "<Report Name>", "created": 1617389428.763803, "created_by": {"name": "<First Name> <Last Name>", "id": 22}, "status": "succeeded", "parameters": {"template": 1234, "date_range": {"start": "2021-01-01", "end": "2021-01-31"}}, "finished": 1617389431.097175, "error": null, "result": {"created": 1617389431.096469, "expires_on": 1617475831.09387, "filename": "<File Name>", "type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "url": "<URL>"}}, "summary": "Example success response", "description": "Report run details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}, "404": {"content": {"application/json": {"schema": {"type": "object", "properties": {"error": {"type": "string", "example": "item not found"}}}}, "text/html; charset=utf-8": {"schema": {"type": "string"}}}, "description": "Not Found"}}}}, "/api/v1/teams/": {"get": {"operationId": "list_teams", "description": "Returns a list of teams.", "summary": "Get a list of teams", "parameters": [{"in": "query", "name": "delta_end", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or before the given date\n            - example: `2021-12-31T23:59:59Z`\n        "}, {"in": "query", "name": "delta_start", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or after the given date\n            - example: `2020-01-01T00:00:00Z`\n        "}, {"in": "query", "name": "include_deactivated", "schema": {"type": "boolean"}, "description": "Whether to include deactivated teams, default true"}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}, {"in": "query", "name": "type", "schema": {"type": "string", "enum": ["allteams", "myteams"], "default": "myteams"}, "description": "Filters teams by type"}], "tags": ["Teams"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/Teams_List_Response"}}, "examples": {"ExampleSuccessResponse": {"value": [{"results": [{"id": 123, "uuid": "659a21e1-4cb7-4ef8-a94e-7d63a56de3a3", "name": "<Team Name>", "picture_uris": {"small": "<URI>", "medium": "<URI>"}, "is_active": true, "created_on": "2021-11-10T21:28:29.610217Z", "modified_on": "2021-11-10T21:28:29.610217Z", "members": [{"name": "<First Name> <Last Name>", "id": 1, "uuid": "cb96dbdc-c996-40ab-9648-2cef1f508998"}, {"name": "<First Name> <Last Name>", "id": 2, "uuid": "e36707ce-6054-4da7-ba03-ccbd4706653d"}]}], "more": true, "nextUrl": "/api/v1/teams/?type=myteams&size=1&page=2"}], "summary": "Example success response", "description": "List of teams"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/teams/{team_id}/": {"get": {"operationId": "get_team", "description": "Returns a team.", "summary": "Get a team", "parameters": [{"in": "path", "name": "team_id", "schema": {"type": "integer"}, "description": "The team ID", "required": true}], "tags": ["Teams"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Team_Full"}, "examples": {"ExampleSuccessResponse": {"value": {"id": 123, "uuid": "659a21e1-4cb7-4ef8-a94e-7d63a56de3a3", "name": "<Team Name>", "picture_uris": {"small": "<URI>", "medium": "<URI>"}, "is_active": true, "created_on": "2021-11-10T21:28:29.610217Z", "modified_on": "2021-11-10T21:28:29.610217Z", "members": [{"name": "<First Name> <Last Name>", "id": 1, "uuid": "cb96dbdc-c996-40ab-9648-2cef1f508998"}, {"name": "<First Name> <Last Name>", "id": 2, "uuid": "e36707ce-6054-4da7-ba03-ccbd4706653d"}]}, "summary": "Example success response", "description": "Team details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "no team found with id: <team_id>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/users/": {"get": {"operationId": "list_users", "description": "Returns a list of users.", "summary": "Get a list of users", "parameters": [{"in": "query", "name": "deactivated", "schema": {"type": "integer", "enum": [0, 1]}, "description": "Filter users by active status - 0 for active users, 1 for deactivated users"}, {"in": "query", "name": "delta_end", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or before the given date\n            - example: `2021-12-31T23:59:59Z`\n        "}, {"in": "query", "name": "delta_start", "schema": {"type": "string", "format": "date-time"}, "description": "Filters items modified on or after the given date\n            - example: `2020-01-01T00:00:00Z`\n        "}, {"in": "query", "name": "department", "schema": {"type": "string"}, "description": "Filter users by department name"}, {"in": "query", "name": "employee_id", "schema": {"type": "string"}, "description": "Filter users by employee ID"}, {"in": "query", "name": "locale", "schema": {"type": "string", "enum": ["cs", "da", "de", "en", "en_GB", "es", "es_419", "fr_CA", "fr_FR", "he", "hi", "hr", "hu", "id", "it", "ja", "km", "ko", "ms", "nl", "no", "pl_PL", "pt_BR", "ro", "ru", "sk", "sv", "th", "tr", "uk", "vi", "zh-Hans", "zh-Hant"]}, "description": "Filter users by locale"}, {"in": "query", "name": "manager_id", "schema": {"type": "integer"}, "description": "Filter users by manager ID"}, {"in": "query", "name": "page", "schema": {"type": "integer"}, "description": "Page number to return (defaults to 1) - must be a positive integer"}, {"in": "query", "name": "size", "schema": {"type": "integer"}, "description": "Number of items to return per page - must be a positive integer"}], "tags": ["Users"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/User_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 81, "uuid": "597b1ebc-5470-4218-8ae1-d2a0d9a2188e", "first_name": "<First Name>", "preferred_name": "<Preferred Name>", "last_name": "<Last Name>", "name": "<First Name> <Last Name>", "email": "<Email Address>", "is_active": true, "deactivated_on": null, "deactivation_date": null, "title": "<Title>", "manager": {"name": "<Manager Name>", "id": 2, "uuid": "7b779133-d6ad-4b75-84b9-903b8e25c15f"}, "department": {"name": "<Department Name>", "id": 3, "uuid": "71bc3fae-cc5b-418b-b863-6a6bb4481404"}, "phone": "<Phone>", "about": "<About>", "locale": "en", "is_goalmaster": false, "is_super_admin": false, "is_admin": false, "is_group_admin": false, "employee_id": "<Employee ID>", "created_on": "2021-11-10T21:30:56.622675Z", "modified_on": "2015-11-13T06:20:55.969761Z", "attributes": {"location": "San Francisco, California", "on_leave": false}, "custom_values": {"custom_property": "<Custom Property Text>"}}], "more": true, "nextUrl": "/api/v1/users?size=10&page=2"}, "summary": "Example success response", "description": "List of users"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid user_id", "No department with the name <department_name> exists", "Invalid value for \"locale\". \"<invalid_locale>\" is not an available option"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/users/{user_id}/": {"get": {"operationId": "get_user", "description": "Returns a user.", "summary": "Get a user", "parameters": [{"in": "path", "name": "user_id", "schema": {"oneOf": [{"type": "integer"}, {"type": "string", "format": "uuid"}, {"type": "string", "format": "email"}]}, "description": "The user ID", "required": true}], "tags": ["Users"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Profile_Full"}, "examples": {"ExampleSuccessResponse": {"value": {"id": 81, "uuid": "597b1ebc-5470-4218-8ae1-d2a0d9a2188e", "first_name": "<First Name>", "preferred_name": "<Preferred Name>", "last_name": "<Last Name>", "name": "<First Name> <Last Name>", "email": "<Email Address>", "is_active": true, "deactivated_on": null, "deactivation_date": null, "title": "<Title>", "manager": {"name": "<Manager Name>", "id": 2, "uuid": "7b779133-d6ad-4b75-84b9-903b8e25c15f"}, "department": {"name": "<Department Name>", "id": 3, "uuid": "71bc3fae-cc5b-418b-b863-6a6bb4481404"}, "phone": "<Phone>", "about": "<About>", "locale": "en", "is_goalmaster": false, "is_super_admin": false, "is_admin": false, "is_group_admin": false, "employee_id": "<Employee ID>", "created_on": "2021-11-10T21:30:56.622675Z", "modified_on": "2015-11-13T06:20:55.969761Z", "attributes": {"location": "San Francisco, California", "on_leave": false}, "custom_values": {"custom_property": "<Custom Property Text>"}}, "summary": "Example success response", "description": "Profile details"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "invalid user_id"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}, "/api/v1/users/bulk/": {"post": {"operationId": "bulk_edit_users", "description": "Returns the number of created and updated users.\n            <strong>This endpoint is only available to users with the super admin role.</strong>\n            Custom fields may be incorporated into the request. Please ensure that these custom fields bear identical names to the keys specified during their creation within the Custom Field configuration in the Administration panel. In the example below, they are identified as `custom_field_a` and `custom_field_n`.\n            <div style=\"padding: 10px; background: #fbe5e1; width: fit-content; border-radius: 10px; margin-bottom: 16px\">This resource does not support bulk delete.</div>\n            <div style=\"padding: 10px; background: #f0f8ff; width: fit-content; border-radius: 10px;\">\n            <strong>Clear Values with BW_NULL:</strong>\n            <ul><li>first_name, last_name, and email can never be `BW_NULL`</li>\n            <li>preferred_name can be `BW_NULL` but the user will fall back to first_name when preferred_name is absent</li>\n            <li>manager_id or manager_email can be `BW_NULL` and will cause both values to be cleared out and removed from the pending user (matches preexisting logic for passing empty string for both of these fields)</li>\n            <li>employee_id can be `BW_NULL` on create but NOT on update (matches preexisting logic for empty string handling)</li>\n            <li>locale can be `BW_NULL` and will clear the record entry but the user will fall back to the org locale if the user locale is empty (matches preexisting logic for empty string handling)</li>\n            <li>If `BW_NULL` is provided for is_active then the field value will default to True</li>\n            <li>If `BW_NULL` is provided for terminated then terminated will default to False, resulting in is_active defaulting to True</li>\n            <li>If `BW_NULL` is provided for deactivation_date then deactivation_date will return True, resulting in is_active being True</li></ul>\n            </div>", "summary": "Create or update multiple users", "tags": ["Users"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["users"], "properties": {"dry_run": {"type": "boolean", "description": "When enabled, will only validate the provided data and ensure\n            there are enough licenses to cover the number of users."}, "users": {"type": "array", "items": {"type": "object", "title": "User", "required": ["email", "first_name", "last_name"], "properties": {"email": {"type": "string", "description": "Domains are pre-approved by BetterWorks. Contact\n                        support@betterworks.com to add more domains.", "example": "email@example.com"}, "first_name": {"type": "string", "description": "The first name of the user.", "example": "Jon"}, "last_name": {"type": "string", "description": "The last name of the user.", "example": "Doe"}, "employee_id": {"type": "string", "description": "Strongly recommended. This field supports re-use\n                        of email address and prevents re-activation of old accounts.", "example": "u1_1234"}, "department_name": {"type": "string", "description": "The name of the department the user belongs to.", "example": "Engineering"}, "title": {"type": "string", "description": "The title of the user.", "example": "Manager"}, "manager_id": {"type": "string", "description": "Employee ID of user\u2019s manager - Must match an\n                    existing employee_id.", "example": "u0_0987"}, "manager_email": {"type": "string", "description": "Email of user\u2019s manager - Strongly recommended.\n                        Must match an existing email.", "example": "manager@example.com"}, "is_active": {"type": "boolean", "description": "Activated/deactivated status of user.\n                        Defaults to True."}, "phone": {"type": "string", "description": "Phone number", "example": "(202)555-0156"}, "location": {"type": "string", "description": "The location of the user.", "example": "United States"}, "preferred_name": {"type": "string", "description": "The preferred name of the user.", "example": "Jon Doe"}, "on_leave": {"type": "boolean", "description": "Is user out of office - will only appear in\n                        admin panel for reporting purposes."}, "matrix_manager": {"type": "string", "description": "Email of a manager that may not be their direct\n                        report in BetterWorks - will only appear in admin panel for\n                        reporting purposes.", "example": "matrixmanager@example.com"}, "locale": {"type": "string", "description": "Locale of the user - defaults to `\"en\"`.", "enum": ["cs", "da", "de", "en", "en_GB", "es", "es_419", "fr_CA", "fr_FR", "he", "hi", "hr", "hu", "id", "it", "ja", "km", "ko", "ms", "nl", "no", "pl_PL", "pt_BR", "ro", "ru", "sk", "sv", "th", "tr", "uk", "vi", "zh-Hans", "zh-Hant"]}, "custom_field_a": {"type": "string"}, "custom_field_n": {"type": "integer"}}}}}}}}}, "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Bulk_User_Update_Response"}, "examples": {"ExampleBulkUserUpdateResponse": {"value": {"created_count": 0, "deactivated_count": 0, "updated_count": 0, "reactivated_count": 0, "errors": [{"index": 0, "first_name": "<First name>", "last_name": "<Last name>", "employee_id": "<Employee ID>", "error_details": [{"description": "<Error description>"}], "processed": false}], "dry_run": false}, "summary": "Example bulk user update response"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}}, "/api/v1/users/bulk/employee-ids/clear/": {"patch": {"operationId": "bulk_edit_employee_ids", "description": "Returns the number of updated users or a list of errors.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Clear the employee_id field for multiple users", "tags": ["Users"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["users"], "description": "A list of user identifiers to clear. Can be a list of UUIDs,\n                    emails, or user IDs.", "properties": {"users": {"type": "array", "items": {"oneOf": [{"type": "string", "format": "uuid"}, {"type": "integer"}, {"type": "string", "format": "email"}]}}}}}}}, "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ApiBulkClearEmployeeIds"}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}}, "/api/v1/users/roles/": {"get": {"operationId": "list_admins", "description": "Returns a list of all users with Admin, Super Admin, or HR Admin privileges.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Get a list of admins", "parameters": [{"in": "path", "name": "id", "schema": {"type": "integer"}, "description": "The user ID", "required": true}], "tags": ["Users"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Admin_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 406, "uuid": "1f772e1a-499d-443e-a6ce-d21690553c97", "role": "superadmin", "admin_since": 1495749951.569638, "managed_departments": [{"name": "<Department Name>", "id": 37, "uuid": "ee4fb7dc-ca91-4a03-93f5-3ec78235da89"}], "managed_admin_groups": [{"name": "<Group Name>", "id": 35, "uuid": "3834ab2e-f5b4-4dee-921a-d6e0d90ffd58"}], "managed_teams": [{"name": "<Team Name>", "id": 31, "uuid": "72e890fa-6ae0-4899-9339-37f17470dd6a "}], "name": "<First Name> <Last Name>"}]}, "summary": "Example success response", "description": "List of admins"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "<error message>"}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}, "put": {"operationId": "update_user_roles", "description": "Returns a list of updated users.\n            <strong>This endpoint is only available to users with the super admin role.</strong>", "summary": "Update user roles", "tags": ["Users"], "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["roles"], "properties": {"roles": {"type": "array", "description": "A list of roles to assign to users", "items": {"type": "object", "title": "RoleAssignment", "required": ["identifier", "role"], "properties": {"identifier": {"oneOf": [{"type": "string", "format": "uuid"}, {"type": "integer", "format": "int32"}, {"type": "string", "format": "email", "example": "person@betterworks.com"}]}, "role": {"type": "string", "enum": ["admin", "super_admin", "groupadmin", "none"]}, "departments": {"type": "array", "description": "This or the `admin_groups` field are required when assigning `groupadmin`. List of departments over which an HR Admin has scope over. Note: When including a department, all children (and grand children, and on) of that department are implicitly included in the HR Admin&#39;s scope.", "items": {"type": "integer", "format": "int32"}}, "admin_groups": {"type": "array", "description": "This or the `departments` field are required when assigning `groupadmin`. List of admin groups over which an HR Admin as scope over. Note: When including an admin group, all children (and grand children, and on) of that group are implicitly included in the HR Admin&#39;s scope.", "items": {"type": "integer", "format": "int32"}}}}}}}}}}, "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Admin_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 406, "uuid": "1f772e1a-499d-443e-a6ce-d21690553c97", "role": "superadmin", "admin_since": 1495749951.569638, "managed_departments": [{"name": "<Department Name>", "id": 37, "uuid": "ee4fb7dc-ca91-4a03-93f5-3ec78235da89"}], "managed_admin_groups": [{"name": "<Group Name>", "id": 35, "uuid": "3834ab2e-f5b4-4dee-921a-d6e0d90ffd58"}], "managed_teams": [{"name": "<Team Name>", "id": 31, "uuid": "72e890fa-6ae0-4899-9339-37f17470dd6a "}], "name": "<First Name> <Last Name>"}]}, "summary": "Example success response", "description": "List of admins"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["requires one, and only one of: user_id, employee_id, email", "Ensure this value is a valid {\"none\": AdminType.none, \"admin\": AdminType.admin, \"superadmin\": AdminType.superadmin, \"groupadmin\": AdminType.groupadmin} (it was <invalid_type)."]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}, "403": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": "You do not have permission to perform this action."}}}}}, "description": "Forbidden"}}}}, "/api/v1/users/search/": {"get": {"operationId": "list_users_by_filter", "description": "Returns a list of users matching the search criteria.\n            <strong>Matches on full name and username.</strong>", "summary": "Search for users", "parameters": [{"in": "query", "name": "can_view_goal_id", "schema": {"type": "integer"}, "description": "Append \"can_view\" to each user in the response if that user has\n                    permission to view the specified goal."}, {"in": "query", "name": "deactivated", "schema": {"type": "boolean", "default": false}, "description": "Search for users that are deactivated"}, {"in": "query", "name": "manager_id", "schema": {"type": "integer"}, "description": "Search for users by their manager&#39;s ID"}, {"in": "query", "name": "q", "schema": {"type": "string"}, "description": "Query string matching user&#39;s full name or email", "required": true}], "tags": ["Users"], "security": [{"API_Public_Token": []}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/User_List_Response"}, "examples": {"ExampleSuccessResponse": {"value": {"results": [{"id": 81, "uuid": "597b1ebc-5470-4218-8ae1-d2a0d9a2188e", "first_name": "<First Name>", "preferred_name": "<Preferred Name>", "last_name": "<Last Name>", "name": "<First Name> <Last Name>", "email": "<Email Address>", "is_active": true, "deactivated_on": null, "deactivation_date": null, "title": "<Title>", "manager": {"name": "<Manager Name>", "id": 2, "uuid": "7b779133-d6ad-4b75-84b9-903b8e25c15f"}, "department": {"name": "<Department Name>", "id": 3, "uuid": "71bc3fae-cc5b-418b-b863-6a6bb4481404"}, "phone": "<Phone>", "about": "<About>", "locale": "en", "is_goalmaster": false, "is_super_admin": false, "is_admin": false, "is_group_admin": false, "employee_id": "<Employee ID>", "created_on": "2021-11-10T21:30:56.622675Z", "modified_on": "2015-11-13T06:20:55.969761Z", "attributes": {"location": "San Francisco, California", "on_leave": false}, "custom_values": {"custom_property": "<Custom Property Text>"}}], "more": true, "nextUrl": "/api/v1/users?size=10&page=2"}, "summary": "Example success response", "description": "List of users"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["query parameter <q> is required", "user search requires <q> to have a minimum length of 3"]}}}}}, "description": "Bad Request"}, "401": {"content": {"application/json": {"schema": {"type": "object", "properties": {"detail": {"type": "string", "example": ["invalid key: <key>", "token is disabled", "Authentication credentials were not provided."]}}}}}, "description": "Unauthorized"}}}}}, "components": {"schemas": {"Admin": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "role": {"$ref": "#/components/schemas/AdminType"}, "admin_since": {"type": "number", "format": "float"}, "managed_departments": {"type": "array", "items": {"$ref": "#/components/schemas/Entity"}, "readOnly": true}, "managed_admin_groups": {"type": "array", "items": {"$ref": "#/components/schemas/Entity"}, "readOnly": true}, "name": {"type": "string"}}, "required": ["admin_since", "id", "managed_admin_groups", "managed_departments", "name", "role", "uuid"]}, "AdminType": {"enum": ["none", "admin", "superadmin", "groupadmin"], "type": "string", "description": "* `none` - none\n* `admin` - admin\n* `superadmin` - superadmin\n* `groupadmin` - groupadmin"}, "Admin_Group": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "is_active": {"type": "boolean"}, "template_usage": {"type": "boolean", "readOnly": true}, "last_edited": {"type": "number", "format": "float"}, "last_edited_by": {"allOf": [{"$ref": "#/components/schemas/Profile"}], "nullable": true}, "member_count": {"type": "integer", "readOnly": true}, "attributes": {"type": "array", "items": {"type": "object", "additionalProperties": {}}, "readOnly": true, "nullable": true}, "additional_members": {"type": "array", "items": {"type": "object", "additionalProperties": {}}, "readOnly": true}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}}, "required": ["additional_members", "attributes", "created_on", "id", "is_active", "last_edited", "last_edited_by", "member_count", "modified_on", "name", "template_usage", "uuid"]}, "Admin_Groups_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Admin_Group"}}, "page": {"type": "integer"}, "num_pages": {"type": "integer"}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "num_pages", "page", "results"]}, "Admin_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Admin"}}}, "required": ["results"]}, "ApiBulkClearEmployeeIds": {"type": "object", "properties": {"updated_count": {"type": "integer"}, "errors": {"type": "array", "items": {"type": "string"}, "nullable": true}}, "required": ["errors", "updated_count"]}, "ApiGoalIntegration": {"type": "object", "properties": {"type": {"$ref": "#/components/schemas/IntegrationType"}, "last_sync": {"type": "number", "format": "float"}, "identifier": {"type": "string", "format": "uuid"}}, "required": ["identifier", "last_sync", "type"]}, "Bulk_User_Update_Response": {"type": "object", "properties": {"created_count": {"type": "integer"}, "deactivated_count": {"type": "integer"}, "updated_count": {"type": "integer"}, "reactivated_count": {"type": "integer"}, "errors": {"type": "array", "items": {"$ref": "#/components/schemas/User_Error_Entity"}}, "dry_run": {"type": "boolean"}}, "required": ["created_count", "deactivated_count", "dry_run", "errors", "reactivated_count", "updated_count"]}, "Calibration_Cycle_Response": {"type": "object", "properties": {"results": {"$ref": "#/components/schemas/Calibration_Cycle_Response_Results"}}, "required": ["results"]}, "Calibration_Cycle_Response_List": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Calibration_Cycle_Response_Results"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "format": "uri"}}, "required": ["more", "results"]}, "Calibration_Cycle_Response_Results": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "conversation_cycle_id": {"type": "integer"}}, "required": ["conversation_cycle_id", "id", "name"]}, "Calibration_Cycle_TalentRecord": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid"}, "subject_id": {"type": "integer"}, "cycle_id": {"type": "string", "format": "uuid"}, "comments_employee": {"type": "string"}, "comments_manager": {"type": "string"}, "compensation_raise": {"type": "string"}, "compensation_raise_percent": {"type": "string"}, "critical_skills": {"type": "string"}, "development_opportunities": {"type": "string"}, "internal_mobility": {"type": "boolean"}, "potential_next_roles": {"type": "string"}, "promotion_promote": {"type": "boolean"}, "promotion_rationale": {"type": "string"}, "promotion_role": {"type": "string"}, "relocate": {"type": "boolean"}, "fellowships": {"type": "boolean"}, "special_program": {"type": "boolean"}, "nominate_as_mentor": {"type": "boolean"}, "nine_box_position": {"type": "array", "items": {"type": "integer"}}, "created_on": {"type": "string", "format": "date-time"}, "created_by": {"type": "integer"}, "modified_on": {"type": "string", "format": "date-time"}, "modified_by": {"type": "integer"}, "ratings": {"type": "array", "items": {"$ref": "#/components/schemas/Calibration_Cycle_TalentRecord_Rating"}}}, "required": ["comments_employee", "comments_manager", "compensation_raise", "compensation_raise_percent", "created_by", "created_on", "critical_skills", "cycle_id", "development_opportunities", "fellowships", "id", "internal_mobility", "modified_by", "modified_on", "nine_box_position", "nominate_as_mentor", "potential_next_roles", "promotion_promote", "promotion_rationale", "promotion_role", "ratings", "relocate", "special_program", "subject_id"]}, "Calibration_Cycle_TalentRecord_List": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Calibration_Cycle_TalentRecord"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "format": "uri"}}, "required": ["more", "results"]}, "Calibration_Cycle_TalentRecord_Rating": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid"}, "rating_type_id": {"type": "string", "format": "uuid"}, "value": {"type": "integer"}, "talent_key": {"type": "string"}, "scale": {"$ref": "#/components/schemas/Calibration_Cycle_TalentRecord_Rating_Scale"}}, "required": ["id", "rating_type_id", "scale", "talent_key", "value"]}, "Calibration_Cycle_TalentRecord_Rating_Scale": {"type": "object", "properties": {"options": {}}, "required": ["options"]}, "Calibration_Cycle_Template": {"type": "object", "properties": {"id": {"type": "string", "format": "uuid"}, "type": {"type": "string"}, "name": {"type": "string"}, "created_on": {"type": "string", "format": "date-time"}, "created_by": {"type": "integer"}, "modified_on": {"type": "string", "format": "date-time"}, "modified_by": {"type": "integer"}, "configuration": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Configuration"}, "mappings": {"type": "array", "items": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Mapping"}}}, "required": ["configuration", "created_by", "created_on", "id", "mappings", "modified_by", "modified_on", "name", "type"]}, "Calibration_Cycle_Template_Configuration": {"type": "object", "properties": {"matrix": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Configuration_Matrix"}, "histogram": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Configuration_Histogram"}, "talent_records": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Configuration_TalentRecords"}}, "required": ["histogram", "matrix", "talent_records"]}, "Calibration_Cycle_Template_Configuration_Histogram": {"type": "object", "properties": {"title": {"type": "string"}, "content": {"type": "array", "items": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Configuration_Matrix_Content"}}, "label_type": {"type": "string"}, "talent_key": {"type": "string"}}, "required": ["content", "talent_key"]}, "Calibration_Cycle_Template_Configuration_Matrix": {"type": "object", "properties": {"axes": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Configuration_Matrix_Axes"}, "content": {}, "dimensions": {"type": "integer"}, "visibility": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Configuration_Matrix_Visibility"}}, "required": ["axes", "content", "dimensions", "visibility"]}, "Calibration_Cycle_Template_Configuration_Matrix_Axes": {"type": "object", "properties": {"x": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Configuration_Matrix_Axes_Axis"}, "y": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Configuration_Matrix_Axes_Axis"}}}, "Calibration_Cycle_Template_Configuration_Matrix_Axes_Axis": {"type": "object", "properties": {"title": {"type": "string"}, "labels": {"type": "array", "items": {"type": "string"}}, "length": {"type": "integer"}, "talent_key": {"type": "string"}}, "required": ["labels", "length", "talent_key", "title"]}, "Calibration_Cycle_Template_Configuration_Matrix_Content": {"type": "object", "properties": {"bg": {"type": "string"}, "color": {"type": "string"}, "label": {"type": "string"}}, "required": ["bg", "color"]}, "Calibration_Cycle_Template_Configuration_Matrix_Visibility": {"type": "object", "properties": {"box_numbers": {"type": "boolean"}}, "required": ["box_numbers"]}, "Calibration_Cycle_Template_Configuration_TalentRecords": {"type": "object", "properties": {"columns": {"type": "array", "items": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Configuration_TalentRecords_Column"}}}, "required": ["columns"]}, "Calibration_Cycle_Template_Configuration_TalentRecords_Column": {"type": "object", "properties": {"display_type": {"type": "string"}, "talent_key": {"type": "string"}, "label": {"type": "string"}, "sortable": {"type": "boolean"}, "read_only": {"type": "boolean"}}, "required": ["display_type", "label", "read_only", "sortable", "talent_key"]}, "Calibration_Cycle_Template_List": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Calibration_Cycle_Template"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "format": "uri"}}, "required": ["more", "results"]}, "Calibration_Cycle_Template_Mapping": {"type": "object", "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "properties": {"$ref": "#/components/schemas/Calibration_Cycle_Template_Mapping_Props"}}, "required": ["id", "properties", "type"]}, "Calibration_Cycle_Template_Mapping_Props": {"type": "object", "properties": {"created_by": {"type": "integer"}, "created_on": {"type": "string", "format": "date-time"}, "cycle_template_id": {"type": "string", "format": "uuid"}, "expression": {"type": "string"}, "modified_by": {"type": "integer"}, "modified_on": {"type": "string", "format": "date-time"}, "talent_key": {"type": "string"}}, "required": ["created_by", "created_on", "cycle_template_id", "expression", "modified_by", "modified_on", "talent_key"]}, "Child_Entity": {"type": "object", "properties": {"name": {"type": "string"}, "id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid", "readOnly": true, "nullable": true}, "modified_on": {"type": "string", "format": "date-time"}}, "required": ["id", "modified_on", "name", "uuid"]}, "Comment": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "created": {"type": "number", "format": "float"}, "edited": {"type": "number", "format": "float", "nullable": true}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}, "text": {"type": "string"}, "author": {"$ref": "#/components/schemas/Profile"}, "goal": {"$ref": "#/components/schemas/Entity"}, "goal_owner": {"$ref": "#/components/schemas/Owner"}, "is_key_result": {"type": "boolean"}}, "required": ["author", "created", "created_on", "edited", "goal", "goal_owner", "id", "is_key_result", "modified_on", "text", "uuid"]}, "ConditionType": {"enum": ["green", "yellow", "red"], "type": "string", "description": "* `green` - green\n* `yellow` - yellow\n* `red` - red"}, "Contributor": {"type": "object", "properties": {"name": {"type": "string"}, "id": {"type": "integer"}, "is_active": {"type": "boolean"}}, "required": ["id", "is_active", "name"]}, "ConversationCycleStage": {"enum": ["primary", "post_cycle"], "type": "string", "description": "* `primary` - primary\n* `post_cycle` - post_cycle"}, "ConversationRole": {"enum": ["employee", "manager", "matrix_manager"], "type": "string", "description": "* `employee` - employee\n* `manager` - manager\n* `matrix_manager` - matrix_manager"}, "ConversationStatus": {"enum": ["not_started", "answering", "submitted", "shared", "completed", "post_hr_pending", "post_hr_not_started", "post_hr_answering", "post_hr_completed"], "type": "string", "description": "* `not_started` - not_started\n* `answering` - answering\n* `submitted` - submitted\n* `shared` - shared\n* `completed` - completed\n* `post_hr_pending` - post_hr_pending\n* `post_hr_not_started` - post_hr_not_started\n* `post_hr_answering` - post_hr_answering\n* `post_hr_completed` - post_hr_completed"}, "ConversationTemplatePermission": {"enum": ["no_access", "can_only_view", "can_edit"], "type": "string", "description": "* `no_access` - no_access\n* `can_only_view` - can_only_view\n* `can_edit` - can_edit"}, "ConversationTemplateType": {"enum": ["scheduled", "adhoc"], "type": "string", "description": "* `scheduled` - scheduled\n* `adhoc` - adhoc"}, "Conversation_Contributor": {"type": "object", "properties": {"user": {"$ref": "#/components/schemas/Profile"}, "status": {"allOf": [{"$ref": "#/components/schemas/ConversationStatus"}], "nullable": true}, "response": {"$ref": "#/components/schemas/Questionnaire_Response"}}, "required": ["response", "status", "user"]}, "Conversation_Cycle": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "role": {"$ref": "#/components/schemas/ConversationRole"}, "stage": {"$ref": "#/components/schemas/ConversationCycleStage"}, "start": {"type": "string", "format": "date"}, "end": {"type": "string", "format": "date"}, "lock_on_share": {"type": "boolean"}, "lock_date": {"type": "string", "format": "date", "nullable": true}, "review_end": {"type": "string", "format": "date", "nullable": true}, "submit_end": {"type": "string", "format": "date", "nullable": true}, "grace_period_end": {"type": "string", "format": "date", "nullable": true}}, "required": ["end", "grace_period_end", "id", "lock_date", "lock_on_share", "review_end", "role", "stage", "start", "submit_end", "uuid"]}, "Conversation_Deployment": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "description": {"type": "string"}, "cycles": {"type": "array", "items": {"$ref": "#/components/schemas/Conversation_Cycle"}}}, "required": ["cycles", "description", "id", "name", "uuid"]}, "Conversation_Summary": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "type": {"$ref": "#/components/schemas/ConversationTemplateType"}, "name": {"type": "string"}, "description": {"type": "string"}, "deployment_id": {"type": "integer"}, "deployment_uuid": {"type": "string", "format": "uuid"}, "manager": {"$ref": "#/components/schemas/Profile"}, "employee": {"$ref": "#/components/schemas/Profile"}, "contributors": {"type": "array", "items": {"$ref": "#/components/schemas/Conversation_Contributor"}, "readOnly": true}, "start": {"type": "string", "format": "date"}, "end": {"type": "string", "format": "date"}, "marked_as_met": {"allOf": [{"$ref": "#/components/schemas/MarkedAsMet"}], "nullable": true}, "manager_response": {"allOf": [{"$ref": "#/components/schemas/Questionnaire_Response"}], "readOnly": true}, "employee_response": {"allOf": [{"$ref": "#/components/schemas/Questionnaire_Response"}], "readOnly": true}, "post_employee_response": {"allOf": [{"$ref": "#/components/schemas/Questionnaire_Response"}], "readOnly": true, "nullable": true}, "post_manager_response": {"allOf": [{"$ref": "#/components/schemas/Questionnaire_Response"}], "readOnly": true, "nullable": true}, "employee_submit_end": {"type": "string", "format": "date", "nullable": true}, "manager_submit_end": {"type": "string", "format": "date", "nullable": true}, "grace_period_end": {"type": "string", "format": "date", "nullable": true}, "employee_review_end": {"type": "string", "format": "date", "nullable": true}, "manager_review_end": {"type": "string", "format": "date", "nullable": true}, "manager_status": {"allOf": [{"$ref": "#/components/schemas/ConversationStatus"}], "readOnly": true}, "employee_status": {"allOf": [{"$ref": "#/components/schemas/ConversationStatus"}], "readOnly": true}, "employee_notes": {"type": "string", "readOnly": true, "nullable": true}, "employee_notes_updated": {"type": "number", "format": "double", "readOnly": true, "nullable": true}, "manager_notes": {"type": "string", "readOnly": true, "nullable": true}, "manager_notes_updated": {"type": "number", "format": "double", "readOnly": true, "nullable": true}, "post_manager_questionnaire_pending": {"type": "boolean", "readOnly": true}, "post_employee_questionnaire_pending": {"type": "boolean", "readOnly": true}, "created": {"type": "number", "format": "float"}, "created_by": {"$ref": "#/components/schemas/Profile"}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "readOnly": true}}, "required": ["contributors", "created", "created_by", "created_on", "deployment_id", "deployment_uuid", "description", "employee", "employee_notes", "employee_notes_updated", "employee_response", "employee_review_end", "employee_status", "employee_submit_end", "end", "grace_period_end", "id", "manager", "manager_notes", "manager_notes_updated", "manager_response", "manager_review_end", "manager_status", "manager_submit_end", "marked_as_met", "modified_on", "name", "post_employee_questionnaire_pending", "post_employee_response", "post_manager_questionnaire_pending", "post_manager_response", "start", "type", "uuid"]}, "Conversation_Template": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "type": {"$ref": "#/components/schemas/ConversationTemplateType"}, "name": {"type": "string"}, "description": {"type": "string"}, "enabled": {"type": "boolean"}, "require_marked_as_met": {"type": "boolean"}, "only_managers_can_initiate": {"type": "boolean", "nullable": true}, "allowed_employees": {"type": "array", "items": {"$ref": "#/components/schemas/User"}}, "allowed_groups": {"type": "array", "items": {"type": "integer"}, "readOnly": true}, "is_goal_creation_enabled": {"type": "boolean"}, "hrq_enabled": {"type": "boolean", "nullable": true}, "hrq_is_concurrent": {"type": "boolean", "nullable": true}, "hrq_notification_on_start": {"type": "boolean", "nullable": true}, "hrq_notification_on_due": {"type": "boolean", "nullable": true}, "notification_on_start": {"type": "boolean"}, "notification_on_end": {"type": "boolean"}, "notification_midcycle_days": {"type": "integer", "nullable": true}, "notification_overdue_days": {"type": "integer", "nullable": true}, "super_admin_permission": {"$ref": "#/components/schemas/ConversationTemplatePermission"}, "hr_admin_permission": {"$ref": "#/components/schemas/ConversationTemplatePermission"}, "skip_level_managers_permission": {"$ref": "#/components/schemas/ConversationTemplatePermission"}, "skip_level_managers_level": {"$ref": "#/components/schemas/SkipLevelManagersLevel"}, "matrix_manager_enabled": {"type": "boolean", "nullable": true}, "matrix_manager_can_see_responses": {"type": "boolean", "nullable": true}, "matrix_manager_can_see_direct_report_responses": {"type": "boolean", "nullable": true}, "deployments": {"type": "array", "items": {"$ref": "#/components/schemas/Conversation_Deployment"}}, "participants": {"type": "array", "items": {"type": "string"}, "readOnly": true}, "hrq_participants": {"type": "array", "items": {"type": "string"}, "readOnly": true}, "created": {"type": "number", "format": "float"}, "created_by": {"$ref": "#/components/schemas/Profile"}, "updated": {"type": "number", "format": "float"}, "updated_by": {"$ref": "#/components/schemas/Profile"}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}}, "required": ["allowed_employees", "allowed_groups", "created", "created_by", "created_on", "deployments", "description", "enabled", "hr_admin_permission", "hrq_enabled", "hrq_is_concurrent", "hrq_notification_on_due", "hrq_notification_on_start", "hrq_participants", "id", "is_goal_creation_enabled", "matrix_manager_can_see_direct_report_responses", "matrix_manager_can_see_responses", "matrix_manager_enabled", "modified_on", "name", "notification_midcycle_days", "notification_on_end", "notification_on_start", "notification_overdue_days", "only_managers_can_initiate", "participants", "require_marked_as_met", "skip_level_managers_level", "skip_level_managers_permission", "super_admin_permission", "type", "updated", "updated_by", "uuid"]}, "Conversation_Templates_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Conversation_Template"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Conversations_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Conversation_Summary"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Department": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "parent": {"allOf": [{"$ref": "#/components/schemas/Entity"}], "nullable": true}, "is_active": {"type": "boolean"}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}}, "required": ["created_on", "id", "is_active", "modified_on", "name", "parent", "uuid"]}, "Departments_Bulk_Update_Response": {"type": "object", "properties": {"created": {"type": "integer"}, "updated": {"type": "integer"}}, "required": ["created", "updated"]}, "Departments_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Department"}}, "page": {"type": "integer"}, "num_pages": {"type": "integer"}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "num_pages", "page", "results"]}, "Entity": {"type": "object", "properties": {"name": {"type": "string"}, "id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid", "readOnly": true, "nullable": true}}, "required": ["id", "name", "uuid"]}, "ErrorDetail": {"type": "object", "properties": {"description": {"type": "string"}}, "required": ["description"]}, "Feedback": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "cycle_id": {"type": "integer", "nullable": true}, "cycle": {"allOf": [{"$ref": "#/components/schemas/Feedback_Cycle"}], "nullable": true}, "for_user": {"$ref": "#/components/schemas/Profile"}, "requested_by": {"allOf": [{"$ref": "#/components/schemas/Profile"}], "readOnly": true, "nullable": true}, "created": {"type": "number", "format": "float"}, "created_by": {"allOf": [{"$ref": "#/components/schemas/Profile"}], "readOnly": true}, "updated": {"type": "number", "format": "float"}, "responses": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Response"}, "readOnly": true}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}, "employee_can_view": {"type": "boolean"}, "manager_can_view": {"type": "boolean"}, "employee_see_identity": {"type": "boolean"}, "manager_see_identity": {"type": "boolean"}, "hold_feedback": {"type": "boolean"}, "status": {"$ref": "#/components/schemas/FeedbackStatus"}, "template_name": {"type": "string"}, "template_type": {"$ref": "#/components/schemas/FeedbackTemplateType"}}, "required": ["created", "created_by", "created_on", "cycle", "cycle_id", "employee_can_view", "employee_see_identity", "for_user", "hold_feedback", "id", "manager_can_view", "manager_see_identity", "modified_on", "name", "requested_by", "responses", "status", "template_name", "template_type", "updated", "uuid"]}, "FeedbackDefaultProviderType": {"enum": ["shared_goals", "classic_360"], "type": "string", "description": "* `shared_goals` - shared_goals\n* `classic_360` - classic_360"}, "FeedbackStatus": {"enum": ["answering", "submitted", "expired", "declined"], "type": "string", "description": "* `answering` - answering\n* `submitted` - submitted\n* `expired` - expired\n* `declined` - declined"}, "FeedbackTemplateType": {"enum": ["scheduled", "adhoc_give", "adhoc_request", "adhoc_manager_request", "adhoc_request_custom", "adhoc_manager_request_custom"], "type": "string", "description": "* `scheduled` - scheduled\n* `adhoc_give` - adhoc_give\n* `adhoc_request` - adhoc_request\n* `adhoc_manager_request` - adhoc_manager_request\n* `adhoc_request_custom` - adhoc_request_custom\n* `adhoc_manager_request_custom` - adhoc_manager_request_custom"}, "FeedbackType": {"enum": ["text", "rating", "scale", "multiple_choice"], "type": "string", "description": "* `text` - text\n* `rating` - rating\n* `scale` - scale\n* `multiple_choice` - multiple_choice"}, "Feedback_Adhoc_Cycle": {"type": "object", "properties": {"id": {"type": "integer"}, "start": {"type": "string", "format": "date"}, "end": {"type": "string", "format": "date"}, "template_id": {"type": "integer"}, "notification_reminder_date": {"type": "string", "format": "date", "nullable": true}, "template_name": {"type": "string"}, "template_questions": {"type": "array", "items": {"type": "string"}, "readOnly": true}, "questions_locked": {"type": "boolean"}}, "required": ["end", "id", "notification_reminder_date", "questions_locked", "start", "template_id", "template_name", "template_questions"]}, "Feedback_Cycle": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "cycle_start": {"type": "string", "format": "date"}, "selection_end": {"type": "string", "format": "date"}, "feedback_start": {"type": "string", "format": "date"}, "cycle_end": {"type": "string", "format": "date"}, "grace_period_end": {"type": "string", "format": "date", "nullable": true}, "enable_anytime_nomination": {"type": "boolean"}}, "required": ["cycle_end", "cycle_start", "enable_anytime_nomination", "feedback_start", "grace_period_end", "id", "selection_end", "uuid"]}, "Feedback_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Feedback_Question": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "template_id": {"type": "integer"}, "type": {"$ref": "#/components/schemas/FeedbackType"}, "text": {"type": "string"}, "options": {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "integer"}]}, "readOnly": true, "nullable": true}, "hide_numbers": {"type": "boolean"}, "order": {"type": "integer"}, "mandatory": {"type": "boolean"}}, "required": ["hide_numbers", "id", "mandatory", "options", "order", "template_id", "text", "type", "uuid"]}, "Feedback_Question_Response": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "question": {"type": "string"}, "question_id": {"type": "integer"}, "question_options": {"type": "string"}, "type": {"$ref": "#/components/schemas/FeedbackType"}, "feedback_id": {"type": "integer"}, "rating": {"type": "integer"}, "rating_range": {"type": "integer"}, "answer": {"type": "string"}, "options_answer": {"type": "string"}, "multiple_choice_answer": {"type": "string"}, "hide_numbers": {"type": "boolean"}}, "required": ["answer", "feedback_id", "hide_numbers", "id", "multiple_choice_answer", "options_answer", "question", "question_id", "question_options", "rating", "rating_range", "type", "uuid"]}, "Feedback_Request": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "cycle": {"allOf": [{"$ref": "#/components/schemas/Feedback_Cycle"}], "nullable": true}, "adhoc_cycle": {"allOf": [{"$ref": "#/components/schemas/Feedback_Adhoc_Cycle"}], "nullable": true}, "from_user": {"allOf": [{"$ref": "#/components/schemas/Profile_Full"}], "readOnly": true}, "for_user": {"$ref": "#/components/schemas/Profile_Full"}, "requested_by": {"allOf": [{"$ref": "#/components/schemas/Profile_Full"}], "nullable": true}, "feedback_id": {"type": "integer"}, "feedback_uuid": {"type": "string", "format": "uuid", "nullable": true}, "question": {"type": "string"}, "declined": {"type": "number", "format": "float"}, "decline_reason": {"type": "string"}, "can_view_feedback": {"type": "boolean", "readOnly": true}, "hold_feedback": {"type": "boolean"}, "created": {"type": "number", "format": "float"}, "created_by": {"$ref": "#/components/schemas/Profile_Full"}, "status": {"allOf": [{"$ref": "#/components/schemas/FeedbackStatus"}], "readOnly": true}, "template_id": {"type": "integer"}, "template_uuid": {"type": "string", "format": "uuid"}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}, "expired": {"type": "string", "format": "date"}, "custom_note": {"type": "string"}}, "required": ["adhoc_cycle", "can_view_feedback", "created", "created_by", "created_on", "custom_note", "cycle", "decline_reason", "declined", "expired", "feedback_id", "feedback_uuid", "for_user", "from_user", "hold_feedback", "id", "modified_on", "question", "requested_by", "status", "template_id", "template_uuid", "uuid"]}, "Feedback_Request_Full": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "cycle": {"allOf": [{"$ref": "#/components/schemas/Feedback_Cycle"}], "nullable": true}, "adhoc_cycle": {"allOf": [{"$ref": "#/components/schemas/Feedback_Adhoc_Cycle"}], "nullable": true}, "from_user": {"allOf": [{"$ref": "#/components/schemas/Profile_Full"}], "readOnly": true}, "for_user": {"$ref": "#/components/schemas/Profile_Full"}, "requested_by": {"allOf": [{"$ref": "#/components/schemas/Profile_Full"}], "nullable": true}, "feedback_id": {"type": "integer"}, "feedback_uuid": {"type": "string", "format": "uuid", "nullable": true}, "question": {"type": "string"}, "declined": {"type": "number", "format": "float"}, "decline_reason": {"type": "string"}, "can_view_feedback": {"type": "boolean", "readOnly": true}, "hold_feedback": {"type": "boolean"}, "created": {"type": "number", "format": "float"}, "created_by": {"$ref": "#/components/schemas/Profile_Full"}, "status": {"allOf": [{"$ref": "#/components/schemas/FeedbackStatus"}], "readOnly": true}, "template_id": {"type": "integer"}, "template_uuid": {"type": "string", "format": "uuid"}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}, "expired": {"type": "string", "format": "date"}, "custom_note": {"type": "string"}, "employee_can_view": {"type": "boolean", "readOnly": true}, "manager_can_view": {"type": "boolean", "readOnly": true}, "skip_level_can_view": {"type": "boolean", "readOnly": true}, "employee_see_identity": {"type": "boolean", "readOnly": true}, "manager_see_identity": {"type": "boolean", "readOnly": true}, "skip_level_see_identity": {"type": "boolean"}, "skip_level_managers_level": {"$ref": "#/components/schemas/SkipLevelManagersLevel"}, "questions": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Question"}, "readOnly": true}, "responses": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Question_Response"}, "readOnly": true}}, "required": ["adhoc_cycle", "can_view_feedback", "created", "created_by", "created_on", "custom_note", "cycle", "decline_reason", "declined", "employee_can_view", "employee_see_identity", "expired", "feedback_id", "feedback_uuid", "for_user", "from_user", "hold_feedback", "id", "manager_can_view", "manager_see_identity", "modified_on", "question", "questions", "requested_by", "responses", "skip_level_can_view", "skip_level_managers_level", "skip_level_see_identity", "status", "template_id", "template_uuid", "uuid"]}, "Feedback_Request_List_Response": {"type": "object", "properties": {"results": {"allOf": [{"$ref": "#/components/schemas/Feedback_Request_List_Result"}], "readOnly": true}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Feedback_Request_List_Result": {"oneOf": [{"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Request_Full"}}, {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Request"}}]}, "Feedback_Response": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "question": {"type": "string"}, "question_id": {"type": "integer", "nullable": true}, "question_uuid": {"type": "string", "format": "uuid", "nullable": true}, "question_options": {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "integer"}]}, "readOnly": true, "nullable": true}, "type": {"$ref": "#/components/schemas/FeedbackType"}, "feedback_id": {"type": "integer"}, "answer": {"oneOf": [{"type": "string"}, {"type": "integer"}, {"type": "array", "items": {"type": "string"}}], "readOnly": true}, "hide_numbers": {"type": "boolean"}}, "required": ["answer", "feedback_id", "hide_numbers", "id", "question", "question_id", "question_options", "question_uuid", "type", "uuid"]}, "Feedback_Template": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "type": {"$ref": "#/components/schemas/FeedbackTemplateType"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "cycles": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Cycle"}}, "created": {"type": "number", "format": "float"}, "updated": {"type": "number", "format": "float"}, "created_on": {"type": "string", "format": "date-time", "nullable": true}, "modified_on": {"type": "string", "format": "date-time", "nullable": true}, "questions_locked": {"type": "boolean"}, "questions": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Question"}, "readOnly": true}, "notify_cycle_started": {"type": "boolean"}, "notify_feedback_reminder": {"type": "boolean"}, "notify_feedback_requested": {"type": "boolean"}, "employee_can_choose": {"type": "boolean"}, "employee_can_view": {"type": "boolean"}, "employee_see_identity": {"type": "boolean"}, "manager_can_choose": {"type": "boolean"}, "manager_can_view": {"type": "boolean"}, "manager_see_identity": {"type": "boolean"}, "skip_level_can_view": {"type": "boolean"}, "skip_level_see_identity": {"type": "boolean"}, "skip_level_managers_level": {"allOf": [{"$ref": "#/components/schemas/SkipLevelManagersLevel"}], "nullable": true}, "default_provider_type": {"allOf": [{"$ref": "#/components/schemas/FeedbackDefaultProviderType"}], "nullable": true}, "default_providers_limit": {"type": "integer", "nullable": true}, "default_providers_includes_manager": {"type": "boolean", "nullable": true}, "default_providers_includes_directs": {"type": "boolean", "nullable": true}, "default_providers_includes_peers": {"type": "boolean", "nullable": true}, "summary_visible_employee": {"type": "boolean"}, "summary_visible_manager": {"type": "boolean"}, "hold_feedback": {"type": "boolean"}, "custom_note_enabled": {"type": "boolean", "nullable": true}}, "required": ["created", "created_on", "custom_note_enabled", "cycles", "default_provider_type", "default_providers_includes_directs", "default_providers_includes_manager", "default_providers_includes_peers", "default_providers_limit", "employee_can_choose", "employee_can_view", "employee_see_identity", "enabled", "hold_feedback", "id", "manager_can_choose", "manager_can_view", "manager_see_identity", "modified_on", "name", "notify_cycle_started", "notify_feedback_reminder", "notify_feedback_requested", "questions", "questions_locked", "skip_level_can_view", "skip_level_managers_level", "skip_level_see_identity", "summary_visible_employee", "summary_visible_manager", "type", "updated", "uuid"]}, "Feedback_Template_Employees_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Profile"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Feedback_Template_Full": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "type": {"$ref": "#/components/schemas/FeedbackTemplateType"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "cycles": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Cycle"}}, "created": {"type": "number", "format": "float"}, "updated": {"type": "number", "format": "float"}, "created_on": {"type": "string", "format": "date-time", "nullable": true}, "modified_on": {"type": "string", "format": "date-time", "nullable": true}, "questions_locked": {"type": "boolean"}, "questions": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Question"}, "readOnly": true}, "notify_cycle_started": {"type": "boolean"}, "notify_feedback_reminder": {"type": "boolean"}, "notify_feedback_requested": {"type": "boolean"}, "employee_can_choose": {"type": "boolean"}, "employee_can_view": {"type": "boolean"}, "employee_see_identity": {"type": "boolean"}, "manager_can_choose": {"type": "boolean"}, "manager_can_view": {"type": "boolean"}, "manager_see_identity": {"type": "boolean"}, "skip_level_can_view": {"type": "boolean"}, "skip_level_see_identity": {"type": "boolean"}, "skip_level_managers_level": {"allOf": [{"$ref": "#/components/schemas/SkipLevelManagersLevel"}], "nullable": true}, "default_provider_type": {"allOf": [{"$ref": "#/components/schemas/FeedbackDefaultProviderType"}], "nullable": true}, "default_providers_limit": {"type": "integer", "nullable": true}, "default_providers_includes_manager": {"type": "boolean", "nullable": true}, "default_providers_includes_directs": {"type": "boolean", "nullable": true}, "default_providers_includes_peers": {"type": "boolean", "nullable": true}, "summary_visible_employee": {"type": "boolean"}, "summary_visible_manager": {"type": "boolean"}, "hold_feedback": {"type": "boolean"}, "custom_note_enabled": {"type": "boolean", "nullable": true}, "allowed_employees": {"type": "array", "items": {"$ref": "#/components/schemas/Profile"}, "readOnly": true}, "allowed_providers": {"type": "array", "items": {"$ref": "#/components/schemas/Profile"}, "readOnly": true}}, "required": ["allowed_employees", "allowed_providers", "created", "created_on", "custom_note_enabled", "cycles", "default_provider_type", "default_providers_includes_directs", "default_providers_includes_manager", "default_providers_includes_peers", "default_providers_limit", "employee_can_choose", "employee_can_view", "employee_see_identity", "enabled", "hold_feedback", "id", "manager_can_choose", "manager_can_view", "manager_see_identity", "modified_on", "name", "notify_cycle_started", "notify_feedback_reminder", "notify_feedback_requested", "questions", "questions_locked", "skip_level_can_view", "skip_level_managers_level", "skip_level_see_identity", "summary_visible_employee", "summary_visible_manager", "type", "updated", "uuid"]}, "Feedback_Template_List_Response": {"type": "object", "properties": {"results": {"allOf": [{"$ref": "#/components/schemas/Feedback_Template_List_Result"}], "readOnly": true}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Feedback_Template_List_Result": {"oneOf": [{"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Template_Full"}}, {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Template_With_Employees"}}, {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Template_With_Providers"}}, {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Template"}}]}, "Feedback_Template_Providers_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Profile"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Feedback_Template_With_Employees": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "type": {"$ref": "#/components/schemas/FeedbackTemplateType"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "cycles": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Cycle"}}, "created": {"type": "number", "format": "float"}, "updated": {"type": "number", "format": "float"}, "created_on": {"type": "string", "format": "date-time", "nullable": true}, "modified_on": {"type": "string", "format": "date-time", "nullable": true}, "questions_locked": {"type": "boolean"}, "questions": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Question"}, "readOnly": true}, "notify_cycle_started": {"type": "boolean"}, "notify_feedback_reminder": {"type": "boolean"}, "notify_feedback_requested": {"type": "boolean"}, "employee_can_choose": {"type": "boolean"}, "employee_can_view": {"type": "boolean"}, "employee_see_identity": {"type": "boolean"}, "manager_can_choose": {"type": "boolean"}, "manager_can_view": {"type": "boolean"}, "manager_see_identity": {"type": "boolean"}, "skip_level_can_view": {"type": "boolean"}, "skip_level_see_identity": {"type": "boolean"}, "skip_level_managers_level": {"allOf": [{"$ref": "#/components/schemas/SkipLevelManagersLevel"}], "nullable": true}, "default_provider_type": {"allOf": [{"$ref": "#/components/schemas/FeedbackDefaultProviderType"}], "nullable": true}, "default_providers_limit": {"type": "integer", "nullable": true}, "default_providers_includes_manager": {"type": "boolean", "nullable": true}, "default_providers_includes_directs": {"type": "boolean", "nullable": true}, "default_providers_includes_peers": {"type": "boolean", "nullable": true}, "summary_visible_employee": {"type": "boolean"}, "summary_visible_manager": {"type": "boolean"}, "hold_feedback": {"type": "boolean"}, "custom_note_enabled": {"type": "boolean", "nullable": true}, "allowed_employees": {"type": "array", "items": {"$ref": "#/components/schemas/Profile"}, "readOnly": true}}, "required": ["allowed_employees", "created", "created_on", "custom_note_enabled", "cycles", "default_provider_type", "default_providers_includes_directs", "default_providers_includes_manager", "default_providers_includes_peers", "default_providers_limit", "employee_can_choose", "employee_can_view", "employee_see_identity", "enabled", "hold_feedback", "id", "manager_can_choose", "manager_can_view", "manager_see_identity", "modified_on", "name", "notify_cycle_started", "notify_feedback_reminder", "notify_feedback_requested", "questions", "questions_locked", "skip_level_can_view", "skip_level_managers_level", "skip_level_see_identity", "summary_visible_employee", "summary_visible_manager", "type", "updated", "uuid"]}, "Feedback_Template_With_Providers": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "type": {"$ref": "#/components/schemas/FeedbackTemplateType"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "cycles": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Cycle"}}, "created": {"type": "number", "format": "float"}, "updated": {"type": "number", "format": "float"}, "created_on": {"type": "string", "format": "date-time", "nullable": true}, "modified_on": {"type": "string", "format": "date-time", "nullable": true}, "questions_locked": {"type": "boolean"}, "questions": {"type": "array", "items": {"$ref": "#/components/schemas/Feedback_Question"}, "readOnly": true}, "notify_cycle_started": {"type": "boolean"}, "notify_feedback_reminder": {"type": "boolean"}, "notify_feedback_requested": {"type": "boolean"}, "employee_can_choose": {"type": "boolean"}, "employee_can_view": {"type": "boolean"}, "employee_see_identity": {"type": "boolean"}, "manager_can_choose": {"type": "boolean"}, "manager_can_view": {"type": "boolean"}, "manager_see_identity": {"type": "boolean"}, "skip_level_can_view": {"type": "boolean"}, "skip_level_see_identity": {"type": "boolean"}, "skip_level_managers_level": {"allOf": [{"$ref": "#/components/schemas/SkipLevelManagersLevel"}], "nullable": true}, "default_provider_type": {"allOf": [{"$ref": "#/components/schemas/FeedbackDefaultProviderType"}], "nullable": true}, "default_providers_limit": {"type": "integer", "nullable": true}, "default_providers_includes_manager": {"type": "boolean", "nullable": true}, "default_providers_includes_directs": {"type": "boolean", "nullable": true}, "default_providers_includes_peers": {"type": "boolean", "nullable": true}, "summary_visible_employee": {"type": "boolean"}, "summary_visible_manager": {"type": "boolean"}, "hold_feedback": {"type": "boolean"}, "custom_note_enabled": {"type": "boolean", "nullable": true}, "allowed_providers": {"type": "array", "items": {"$ref": "#/components/schemas/Profile"}, "readOnly": true}}, "required": ["allowed_providers", "created", "created_on", "custom_note_enabled", "cycles", "default_provider_type", "default_providers_includes_directs", "default_providers_includes_manager", "default_providers_includes_peers", "default_providers_limit", "employee_can_choose", "employee_can_view", "employee_see_identity", "enabled", "hold_feedback", "id", "manager_can_choose", "manager_can_view", "manager_see_identity", "modified_on", "name", "notify_cycle_started", "notify_feedback_reminder", "notify_feedback_requested", "questions", "questions_locked", "skip_level_can_view", "skip_level_managers_level", "skip_level_see_identity", "summary_visible_employee", "summary_visible_manager", "type", "updated", "uuid"]}, "Goal": {"type": "object", "properties": {"description": {"type": "string"}, "id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "is_key_result": {"type": "boolean"}, "end": {"type": "string", "format": "date"}, "start": {"type": "string", "format": "date"}, "measurement": {"$ref": "#/components/schemas/Goal_Measurement"}, "owner": {"allOf": [{"$ref": "#/components/schemas/Owner"}], "readOnly": true}, "parent": {"allOf": [{"$ref": "#/components/schemas/Entity"}], "nullable": true}, "children": {"type": "array", "items": {"$ref": "#/components/schemas/Child_Entity"}}, "updated": {"type": "number", "format": "float"}, "updated_by": {"$ref": "#/components/schemas/Profile"}, "visibility": {"$ref": "#/components/schemas/Visibility"}, "integration": {"allOf": [{"$ref": "#/components/schemas/ApiGoalIntegration"}], "readOnly": true, "nullable": true}, "stats": {"$ref": "#/components/schemas/Goal_Stats"}, "categories": {"type": "array", "items": {"$ref": "#/components/schemas/Entity"}}, "attribute_type": {"type": "string", "readOnly": true, "nullable": true}, "attribute_scope": {"type": "string", "readOnly": true, "nullable": true}, "is_shared_with_downline": {"type": "boolean", "nullable": true}, "created": {"type": "number", "format": "float"}, "created_by": {"$ref": "#/components/schemas/Profile"}, "last_checkedin": {"type": "number", "format": "float", "nullable": true}, "last_checkedin_by": {"allOf": [{"$ref": "#/components/schemas/Profile"}], "nullable": true}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}}, "required": ["attribute_scope", "attribute_type", "categories", "children", "created", "created_by", "created_on", "description", "end", "id", "integration", "is_key_result", "is_shared_with_downline", "last_checkedin", "last_checkedin_by", "measurement", "modified_on", "name", "owner", "parent", "start", "stats", "updated", "updated_by", "uuid", "visibility"]}, "Goal_Assessment": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "created": {"type": "number", "format": "float"}, "edited": {"type": "number", "format": "float"}, "created_by": {"$ref": "#/components/schemas/Profile"}, "goal_id": {"type": "integer"}, "comment": {"type": "string"}, "score": {"type": "number", "format": "double"}}, "required": ["comment", "created", "created_by", "edited", "goal_id", "id", "score", "uuid"]}, "Goal_Category": {"type": "object", "properties": {"id": {"type": "integer"}, "name": {"type": "string"}, "updated": {"type": "number", "format": "float"}, "updated_by_id": {"type": "integer"}, "created": {"type": "number", "format": "float"}, "created_by_id": {"type": "integer"}}, "required": ["created", "created_by_id", "id", "name", "updated", "updated_by_id"]}, "Goal_Category_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Goal_Category"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Goal_Comment_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Comment"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Goal_Filter": {"type": "object", "properties": {"description": {"type": "string"}, "id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "is_key_result": {"type": "boolean"}, "end": {"type": "string", "format": "date"}, "start": {"type": "string", "format": "date"}, "measurement": {"$ref": "#/components/schemas/Goal_Measurement"}, "owner": {"allOf": [{"$ref": "#/components/schemas/Owner"}], "readOnly": true}, "parent": {"allOf": [{"$ref": "#/components/schemas/Entity"}], "nullable": true}, "children": {"type": "array", "items": {"$ref": "#/components/schemas/Child_Entity"}}, "updated": {"type": "number", "format": "float"}, "updated_by": {"$ref": "#/components/schemas/Profile"}, "visibility": {"$ref": "#/components/schemas/Visibility"}, "integration": {"allOf": [{"$ref": "#/components/schemas/ApiGoalIntegration"}], "readOnly": true, "nullable": true}, "stats": {"$ref": "#/components/schemas/Goal_Stats"}, "categories": {"type": "array", "items": {"$ref": "#/components/schemas/Entity"}}, "attribute_type": {"type": "string", "readOnly": true, "nullable": true}, "attribute_scope": {"type": "string", "readOnly": true, "nullable": true}, "is_shared_with_downline": {"type": "boolean", "nullable": true}, "created": {"type": "number", "format": "float"}, "created_by": {"$ref": "#/components/schemas/Profile"}, "last_checkedin": {"type": "number", "format": "float", "nullable": true}, "last_checkedin_by": {"allOf": [{"$ref": "#/components/schemas/Profile"}], "nullable": true}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}, "contributors": {"type": "array", "items": {"$ref": "#/components/schemas/Contributor"}, "nullable": true}}, "required": ["attribute_scope", "attribute_type", "categories", "children", "contributors", "created", "created_by", "created_on", "description", "end", "id", "integration", "is_key_result", "is_shared_with_downline", "last_checkedin", "last_checkedin_by", "measurement", "modified_on", "name", "owner", "parent", "start", "stats", "updated", "updated_by", "uuid", "visibility"]}, "Goal_Filter_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Goal_Filter"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Goal_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Goal"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Goal_Measurement": {"type": "object", "properties": {"progress": {"type": "number", "format": "double"}, "initial": {"type": "number", "format": "double", "nullable": true}, "target": {"type": "number", "format": "double", "nullable": true}, "unit": {"type": "string"}, "done": {"type": "boolean"}, "lower_limit": {"type": "number", "format": "double", "nullable": true}, "lower_mid": {"type": "number", "format": "double", "nullable": true}, "upper_limit": {"type": "number", "format": "double", "nullable": true}, "upper_mid": {"type": "number", "format": "double", "nullable": true}, "current": {"type": "number", "format": "double", "nullable": true}, "updated": {"type": "number", "format": "float"}, "updated_by": {"$ref": "#/components/schemas/Profile"}, "type": {"$ref": "#/components/schemas/MeasurementType"}, "expected": {"type": "number", "format": "double", "readOnly": true}, "condition": {"allOf": [{"$ref": "#/components/schemas/ConditionType"}], "readOnly": true}, "is_binary": {"type": "boolean", "readOnly": true}, "is_numeric": {"type": "boolean", "readOnly": true}}, "required": ["condition", "current", "done", "expected", "initial", "is_binary", "is_numeric", "lower_limit", "lower_mid", "progress", "target", "type", "unit", "updated", "updated_by", "upper_limit", "upper_mid"]}, "Goal_Stats": {"type": "object", "properties": {"comments": {"type": "integer"}, "cheers": {"type": "integer"}, "nudges": {"type": "integer"}, "views": {"type": "integer"}, "last_assessed": {"type": "number", "format": "float", "nullable": true}}, "required": ["cheers", "comments", "last_assessed", "nudges", "views"]}, "Group": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}}, "required": ["id", "name", "uuid"]}, "Group_Full": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "parent_id": {"type": "integer"}, "picture_uris": {"$ref": "#/components/schemas/Group_Picture"}, "is_active": {"type": "boolean"}, "is_team": {"type": "boolean"}}, "required": ["id", "is_active", "is_team", "name", "parent_id", "picture_uris", "uuid"]}, "Group_Picture": {"type": "object", "properties": {"small": {"type": "string", "format": "uri"}, "medium": {"type": "string", "format": "uri"}}, "required": ["medium", "small"]}, "Hashtag": {"type": "object", "properties": {"name": {"type": "string"}, "id": {"type": "integer"}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}}, "required": ["created_on", "id", "modified_on", "name"]}, "Hashtags_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Hashtag"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "IntegrationType": {"enum": ["salesforce", "jira", "tableau", "sheets", "integrated", "udemy", "ado", "excel365", "linkedinlearning"], "type": "string", "description": "* `salesforce` - salesforce\n* `jira` - jira\n* `tableau` - tableau\n* `sheets` - sheets\n* `integrated` - integrated\n* `udemy` - udemy\n* `ado` - ado\n* `excel365` - excel365\n* `linkedinlearning` - linkedinlearning"}, "Integration_Full": {"type": "object", "properties": {"type": {"$ref": "#/components/schemas/TypeEnum"}, "items": {"allOf": [{"$ref": "#/components/schemas/Integration_Items"}], "readOnly": true}}, "required": ["items", "type"]}, "Integration_Items": {"oneOf": [{"type": "array", "items": {"$ref": "#/components/schemas/JiraIssueSet"}}]}, "JiraIssueSet": {"type": "object", "properties": {"key": {"type": "string"}, "summary": {"type": "string"}, "status": {"type": "string"}, "resolution_status": {"type": "string", "nullable": true}, "is_resolved": {"type": "boolean"}, "url": {"type": "string"}}, "required": ["is_resolved", "key", "resolution_status", "status", "summary", "url"]}, "MarkedAsMet": {"enum": ["not_required", "met", "not_met"], "type": "string", "description": "* `not_required` - not_required\n* `met` - met\n* `not_met` - not_met"}, "MeasurementType": {"enum": ["avgofprogress", "sumofcurrent", "sumofrange", "manualprogress", "binary", "numeric", "range"], "type": "string", "description": "* `avgofprogress` - avgofprogress\n* `sumofcurrent` - sumofcurrent\n* `sumofrange` - sumofrange\n* `manualprogress` - manualprogress\n* `binary` - binary\n* `numeric` - numeric\n* `range` - range"}, "Owner": {"type": "object", "properties": {"user": {"allOf": [{"$ref": "#/components/schemas/Profile"}], "readOnly": true, "nullable": true}, "group": {"allOf": [{"$ref": "#/components/schemas/Group_Full"}], "readOnly": true, "nullable": true}, "team": {"allOf": [{"$ref": "#/components/schemas/Team"}], "readOnly": true, "nullable": true}}, "required": ["group", "team", "user"]}, "Profile": {"type": "object", "properties": {"name": {"type": "string"}, "id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}}, "required": ["id", "name", "uuid"]}, "Profile_Full": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "first_name": {"type": "string"}, "preferred_name": {"type": "string"}, "last_name": {"type": "string"}, "name": {"type": "string"}, "email": {"type": "string", "format": "email"}, "is_active": {"type": "boolean"}, "deactivated_on": {"type": "string", "format": "date-time", "nullable": true}, "deactivation_date": {"type": "string", "format": "date", "nullable": true}, "title": {"type": "string", "nullable": true}, "manager": {"allOf": [{"$ref": "#/components/schemas/Profile"}], "nullable": true}, "department": {"allOf": [{"$ref": "#/components/schemas/Entity"}], "nullable": true}, "phone": {"type": "string"}, "about": {"type": "string"}, "locale": {"type": "string", "nullable": true}, "is_goalmaster": {"type": "boolean"}, "is_super_admin": {"type": "boolean"}, "is_admin": {"type": "boolean"}, "is_group_admin": {"type": "boolean"}, "employee_id": {"type": "string"}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}, "attributes": {"type": "object", "additionalProperties": {}, "readOnly": true}, "custom_values": {"type": "object", "additionalProperties": {}, "readOnly": true}}, "required": ["about", "attributes", "created_on", "custom_values", "deactivated_on", "deactivation_date", "department", "email", "employee_id", "first_name", "id", "is_active", "is_admin", "is_goalmaster", "is_group_admin", "is_super_admin", "last_name", "locale", "manager", "modified_on", "name", "phone", "preferred_name", "title", "uuid"]}, "QuestionType": {"enum": ["text", "scale", "rating", "multiple_choice"], "type": "string", "description": "* `text` - text\n* `scale` - scale\n* `rating` - rating\n* `multiple_choice` - multiple_choice"}, "Question_Response": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "type": {"$ref": "#/components/schemas/QuestionType"}, "question_id": {"type": "integer"}, "question_uuid": {"type": "string", "format": "uuid", "nullable": true}, "question": {"type": "string"}, "question_options": {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "integer"}]}, "readOnly": true}, "answer": {"oneOf": [{"type": "string"}, {"type": "integer"}, {"type": "array", "items": {"type": "string"}}], "readOnly": true}, "lock_date": {"type": "string", "format": "date", "nullable": true}, "created": {"type": "number", "format": "float"}, "updated": {"type": "number", "format": "float"}, "created_on": {"type": "string", "format": "date-time", "nullable": true}, "modified_on": {"type": "string", "format": "date-time", "nullable": true}, "rating_range": {"type": "string"}}, "required": ["answer", "created", "created_on", "id", "lock_date", "modified_on", "question", "question_id", "question_options", "question_uuid", "rating_range", "type", "updated", "uuid"]}, "Questionnaire_Response": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "shared_on": {"type": "number", "format": "float"}, "submitted_on": {"type": "number", "format": "float"}, "unlocked_until": {"type": "string", "format": "date", "nullable": true}, "responses": {"type": "array", "items": {"$ref": "#/components/schemas/Question_Response"}, "readOnly": true}, "updated": {"type": "number", "format": "float"}, "updated_by": {"allOf": [{"$ref": "#/components/schemas/Profile"}], "nullable": true}, "created": {"type": "number", "format": "float"}, "created_by": {"allOf": [{"$ref": "#/components/schemas/Profile"}], "nullable": true}, "created_on": {"type": "string", "format": "date-time", "nullable": true}, "modified_on": {"type": "string", "format": "date-time", "nullable": true}}, "required": ["created", "created_by", "created_on", "id", "modified_on", "responses", "shared_on", "submitted_on", "unlocked_until", "updated", "updated_by", "uuid"]}, "Recognition": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "author": {"$ref": "#/components/schemas/Profile"}, "for_user": {"allOf": [{"$ref": "#/components/schemas/Profile"}], "nullable": true}, "for_group": {"allOf": [{"$ref": "#/components/schemas/Group"}], "nullable": true}, "mentioned_users": {"type": "array", "items": {"$ref": "#/components/schemas/Profile"}, "readOnly": true}, "hashtags": {"type": "array", "items": {"$ref": "#/components/schemas/Entity"}}, "source": {"$ref": "#/components/schemas/Recognition_Source"}, "created": {"type": "number", "format": "float"}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}}, "required": ["author", "created", "created_on", "for_group", "for_user", "hashtags", "id", "mentioned_users", "modified_on", "source", "uuid"]}, "Recognition_Source": {"type": "object", "properties": {"comment": {"allOf": [{"$ref": "#/components/schemas/Comment"}], "nullable": true}, "shoutout": {"allOf": [{"$ref": "#/components/schemas/Shoutout"}], "nullable": true}}, "required": ["comment", "shoutout"]}, "Recognitions_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Recognition"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Report_Run": {"type": "object", "properties": {"id": {"type": "integer"}, "report": {"type": "string"}, "created": {"type": "number", "format": "float"}, "created_by": {"$ref": "#/components/schemas/Profile"}, "status": {"type": "string"}, "parameters": {"type": "object", "additionalProperties": {}}, "finished": {"type": "number", "format": "float", "nullable": true}, "error": {"type": "string", "readOnly": true, "nullable": true}, "result": {"allOf": [{"$ref": "#/components/schemas/Report_Run_Result"}], "readOnly": true, "nullable": true}}, "required": ["created", "created_by", "error", "finished", "id", "parameters", "report", "result", "status"]}, "Report_Run_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Report_Run"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Report_Run_Result": {"type": "object", "properties": {"created": {"type": "number", "format": "float"}, "expires_on": {"type": "number", "format": "float"}, "filename": {"type": "string"}, "type": {"type": "string"}, "url": {"type": "string"}}, "required": ["created", "expires_on", "filename", "type", "url"]}, "Shoutout": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "for_user_id": {"type": "integer"}, "for_user_name": {"type": "string"}, "author_id": {"type": "integer"}, "author_name": {"type": "string"}, "text": {"type": "string"}, "created": {"type": "number", "format": "float"}, "edited": {"type": "number", "format": "float", "nullable": true}}, "required": ["author_id", "author_name", "created", "edited", "for_user_id", "for_user_name", "id", "text", "uuid"]}, "SkipLevelManagersLevel": {"enum": ["none", "one", "two", "any"], "type": "string", "description": "* `none` - none\n* `one` - one\n* `two` - two\n* `any` - any"}, "Team": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "picture_uris": {"$ref": "#/components/schemas/Group_Picture"}, "is_active": {"type": "boolean"}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}}, "required": ["created_on", "id", "is_active", "modified_on", "name", "picture_uris", "uuid"]}, "Team_Full": {"type": "object", "properties": {"id": {"type": "integer"}, "uuid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "picture_uris": {"$ref": "#/components/schemas/Group_Picture"}, "is_active": {"type": "boolean"}, "created_on": {"type": "string", "format": "date-time"}, "modified_on": {"type": "string", "format": "date-time"}, "members": {"type": "array", "items": {"$ref": "#/components/schemas/Profile"}, "readOnly": true}}, "required": ["created_on", "id", "is_active", "members", "modified_on", "name", "picture_uris", "uuid"]}, "Teams_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Team_Full"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "TypeEnum": {"enum": ["jira"], "type": "string", "description": "* `jira` - jira"}, "User": {"type": "object", "properties": {"id": {"type": "integer"}, "name": {"type": "string"}, "is_active": {"type": "boolean"}, "email": {"type": "string", "format": "email"}}, "required": ["email", "id", "is_active", "name"]}, "User_Error_Entity": {"type": "object", "properties": {"index": {"type": "integer"}, "first_name": {"type": "string", "nullable": true}, "last_name": {"type": "string", "nullable": true}, "employee_id": {"type": "string", "nullable": true}, "error_details": {"type": "array", "items": {"$ref": "#/components/schemas/ErrorDetail"}}, "processed": {"type": "boolean"}}, "required": ["employee_id", "error_details", "first_name", "index", "last_name", "processed"]}, "User_List_Response": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/components/schemas/Profile_Full"}}, "more": {"type": "boolean"}, "nextUrl": {"type": "string", "nullable": true}}, "required": ["more", "nextUrl", "results"]}, "Visibility": {"enum": ["public", "private", "locked"], "type": "string", "description": "* `public` - public\n* `private` - private\n* `locked` - locked"}}, "securitySchemes": {"API_Public_Token": {"type": "apiKey", "in": "header", "name": "Authorization", "description": "Token-based authentication with required prefix \"APIToken\""}}}, "tags": [{"name": "Introduction", "description": "The Betterworks REST API enables users to securely connect Betterworks to other business-critical applications in a way that&#39;s both straightforward and automatic. \n\n                \n All API responses return JSON, including errors. To allow for testing, you can make API keys in the Betterworks Preview Environment.\n                The Preview Environment is refreshed at the end of every month, so a new key will need to be generated each month.\n                Production keys are live until deactivated via the Betterworks admin portal. \n\n                \n This documentation refers to Betterworks work units as \u201cgoals\u201d and \u201cmilestones.\u201d\n                These units are  interchangeable with \u201cObjectives\u201d and \u201cKey Results\u201d respectively, so if your organization uses OKRs, remember that every \u201cgoal\u201d is an \u201cObjective\u201d and every \u201cmilestone\u201d is a \u201cKey Result.\u201d"}, {"name": "Authentication", "description": "Each call to the API is authenticated by including your secret API token in the request.\n                API tokens are managed through the Betterworks Admin portal. Please contact your Betterworks Admin to obtain a token.\n                Each token carries the permissions of the user assigned to the token. All API requests must be made over HTTPS.\n                Calls made over plain HTTP will fail. API requests without authentication will also fail. \n\n                `curl -X GET \"https://app.betterworks.com/v1/user\" \n\n                  -H \"Authorization: APIToken abcdefghijklmnopqrstuvwxyz123456789\" \n\n                  -H \"Content-Type: application/json\"` \n\n                \n <div style=\"padding: 10px; background: #fbe5e1; width: fit-content; border-radius: 10px;\">The Betterworks API does not currently support CORS requests.</div>"}, {"name": "URI Structure and Versioning", "description": "All Betterworks APIs require specifying an API version in the request URL. \n\n                \n <strong>Note:</strong> EU customers should always use `eu.betterworks.com` instead of `app.betterworks.com` \n\n                \n Ex. `GET https://app.betterworks.com/api/<Version>/user/` or \n `GET https://preview.betterworks.com/api/<Version>/user/` if developing against the preview environment. \n\n                \n Newer versions of the API will include new features and improvements and you should consider upgrading to the latest version whenever possible. \n\n                \n The most current API version is <strong>V1</strong>(`GET https://app.betterworks.com/api/v1/user/`).\n                \n New versions of the API will be communicated to your Betterworks admin and via our <a href=\"https://support.betterworks.com\" target=\"_blank\">support page</a>."}, {"name": "Permissions", "description": "Permissions for API keys will always match the permissions allowed to the user in which the API key is assigned.\n                For example, if a user owns a private goal, that goal will be visible to requests made using any key attached to the user ( and will not be visible for API keys attached to users that do not have permission to view). \n\n                \n In addition, some APIs require additional administrative privileges in order to function."}, {"name": "Pagination", "description": "All Betterworks APIs support pagination. The supplying page will select which page of content you get, and size will dictate the number of entities returned per page. \n\n                \n Ex. `/api/v1/departments/?page=1&size=15` \n\n                \n If `more` is true, you can get the next page of results by querying the `nextURL`"}, {"name": "Delta Filters", "description": "Many Betterworks API endpoints support delta filters, allowing the client to specify a range of dates in ISO format `YYYY-MM-DD` that filter results based on the item&#39;s `modified_on` field.\n                Delta filters support `delta_start` and `delta_end` operators which can be combined to filter on a range of dates or applied individually. \n\n                \n In the example below the API will return all users modified on or after January 1st 2019.\n                \n <li><code>GET https://app.betterworks.com/api/v1/users?delta_start=2019-01-01</code></li> \n\n                \n In the example below the API will return all users modified on or before January 1st 2019. \n\n                \n <li><code>GET https://app.betterworks.com/api/v1/users?delta_end=2019-01-01</code></li> \n\n                \n In the example below the API will return all users modified between January 1st 2019 and January 31st 2019. \n\n                \n <li><code>GET https://app.betterworks.com/api/v1/users?delta_start=2019-01-01&delta_end=2019-01-31</code></li> \n\n                \n Delta filters support extended ISO formats including time of day `YYYY-MM-DDTHH:MM:SS` and timezone information `YYYY-MM-DDTHH:MM:SS.SSSZ`.\n                If no timezone information is provided, the date is assumed to be in UTC.\n                If no time is provided for `delta_start` then the beginning of the day is assumed `00:00:00`.\n                If no time is provided for `delta_end` then the end of the day is assumed `23:59:59`. \n\n                \n More details about ISO format can be found here: <a href=\"https://www.w3.org/TR/NOTE-datetime\" target=\"_blank\">W3 Date and Time Formats</a>."}, {"name": "Admin Groups", "description": "In the Betterworks system, groups can be any collection of users, and are typically a cohort of users by say physical location, or seniority.\n                Groups are only created by Super Admins in the platform and are primarily used when scheduling conversation cycles. \n\n                \n Learn more about <a href=\"https://support.betterworks.com/hc/en-us/articles/360031090551-Organizing-Users-Into-Groups\" target=\"_blank\">admin groups</a>."}, {"name": "Calibration", "description": "Calibration aggregates data that you\u2019ve created or changed (e.g. performance and potential ratings, matrix (9box) positioning, etc.) for HR and leadership decision-making purposes. This includes cycle (a collection of talent records), and talent record (employee specific data within a cycle and its associated session) data.\n                \n Learn more about <a href=\"https://support.betterworks.com/hc/en-us/articles/360040312412-Calibration-Overview-Setup\">Calibration</a>."}, {"name": "Conversations", "description": "In the Betterworks system, Conversations can take two forms, anytime(adhoc) or scheduled.\n                Each Conversation follows a Conversation Template which dictates the attributes of the conversation.\n                Each Conversation Template deployments represent a summary of conversations.\n                These deployments represent the time frame for a given set of conversations, whether they be appointed or on demand.\n                This range of time includes the start, end, review and notification dates for all stages and participant roles for a conversation taking place at that defined time. \n\n                \n Learn more about <a href=\"https://support.betterworks.com/hc/en-us/articles/214429166-Configuring-Managing-Conversations\" target=\"_blank\">conversations</a>."}, {"name": "Departments", "description": "Learn more about <a href=\"https://support.betterworks.com/hc/en-us/articles/360031393992-Using-Departments-Groups-Teams\" target=\"_blank\">departments</a>."}, {"name": "Feedback", "description": "In the Betterworks system, Feedback is a meaningful appraisal of your efforts that reinforces your areas of strength and identifies areas for personal and professional growth and development.\n                Feedbacks have an id which can be used to filter in the API.\n                Feedbacks follow a Feedback Template, designated by a template_id, which dictates the feedback attributes.\n                They are given within a cycle and can be anytime (adhoc) or scheduled. Users can either request feedback or give feedback. \n\n                \n Learn more about <a href=\"https://support.betterworks.com/hc/en-us/articles/115000676323-Configuring-Managing-Feedback\" target=\"_blank\">feedback</a>."}, {"name": "Goals and Milestones", "description": "In the Betterworks system, Goals may have any number of milestones(also called Key Results) or other goals as children which will contribute to their parents progress.\n                Goals and Milestones are serialized nearly identically, with Milestones being identifiable by the is_key_result: true attribute.\n                Throughout the API both Goals and Milestones can be referenced interchangeably by goals /: goal_id in the URL, though the specific endpoints may handle them differently./ \n\n                \n Learn more about <a href=\"https://support.betterworks.com/hc/en-us/articles/4412049001741-Creating-Managing-Goals-Milestones\" target=\"_blank\">goals</a>."}, {"name": "Hashtags", "description": ""}, {"name": "Integrations", "description": ""}, {"name": "Recognitions", "description": "In the Betterworks system, Recognition is a thoughtful acknowledgement of another person&#39;s efforts, achievements, and performance.\n                Recognitions can be filtered on hashtags, start and end dates, or user/group IDs. \n\n                \n Learn more about <a href=\"https://support.betterworks.com/hc/en-us/articles/4425786622093-Configuring-Recognition\" target=\"_blank\">recognitions</a>."}, {"name": "Reports", "description": "In the Betterworks system, Reports allow you to view activity, goals, conversations, feedbacks, and recognitions."}, {"name": "Teams", "description": "In the Betterworks system, teams can be any collection of users, and are typically made up of people from different departments working on the same project.\n                Also referred to as \"dotted line\" managers or a matrix structure where a person reports to two managers: one for daily tasks on a project, and another manager responsible for their performance and development. \n\n                \n Learn more about <a href=\"https://support.betterworks.com/hc/en-us/articles/218352383\" target=\"_blank\">teams</a>."}, {"name": "Users", "description": "Learn more about <a href=\"https://support.betterworks.com/hc/en-us/articles/360032136951-Adding-Updating-Users-Individual-Update\" target=\"_blank\">users</a>."}, {"name": "Support", "description": "We pride ourselves on providing top notch support for our customers.\n                To learn more about Betterworks please visit our <a href=\"https://support.betterworks.com\" target=\"_blank\">support center</a>.\n                Upcoming events hosted by or attended by Betterworks can be found <a href=\"https://www.betterworks.com/events-community\" target=\"_blank\">here</a>."}]}