openapi: 3.0.3 info: title: '' version: v2 paths: /api/v2/account: get: operationId: account_list description: |- Return a list of accounts. --- parameters: - name: page required: false type: integer paramType: query description: Desired page number of results parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: query required: false in: query description: A search term. schema: type: string tags: - Account security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAccountList' description: '' post: operationId: account_create description: Create a new account tags: - Account requestBody: content: application/json: schema: $ref: '#/components/schemas/Account' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Account' multipart/form-data: schema: $ref: '#/components/schemas/Account' '*/*': schema: $ref: '#/components/schemas/Account' text/csv: schema: $ref: '#/components/schemas/Account' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Account' description: '' /api/v2/account/{id}: get: operationId: account_retrieve description: Return a single account. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this account. required: true tags: - Account security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Account' description: '' put: operationId: account_update parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this account. required: true tags: - Account requestBody: content: application/json: schema: $ref: '#/components/schemas/Account' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Account' multipart/form-data: schema: $ref: '#/components/schemas/Account' '*/*': schema: $ref: '#/components/schemas/Account' text/csv: schema: $ref: '#/components/schemas/Account' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Account' description: '' patch: operationId: account_partial_update parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this account. required: true tags: - Account requestBody: content: application/json: schema: $ref: '#/components/schemas/Account' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Account' multipart/form-data: schema: $ref: '#/components/schemas/Account' '*/*': schema: $ref: '#/components/schemas/Account' text/csv: schema: $ref: '#/components/schemas/Account' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Account' description: '' delete: operationId: account_destroy parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this account. required: true tags: - Account security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '204': description: No response body /api/v2/account_integration: get: operationId: account_integration_list description: |- List account integrations --- parameters: - name: page required: false type: integer paramType: query description: Desired page number of results parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer tags: - Account security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAccountIntegrationList' description: '' post: operationId: account_integration_create description: Create/Update account integrations tags: - Account requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountIntegration' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountIntegration' multipart/form-data: schema: $ref: '#/components/schemas/AccountIntegration' '*/*': schema: $ref: '#/components/schemas/AccountIntegration' text/csv: schema: $ref: '#/components/schemas/AccountIntegration' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AccountIntegration' description: '' /api/v2/account_integration/{id}: get: operationId: account_integration_retrieve description: Account Integration API parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity integration. required: true tags: - Account security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountIntegration' description: '' put: operationId: account_integration_update description: Account Integration API parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity integration. required: true tags: - Account requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountIntegration' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountIntegration' multipart/form-data: schema: $ref: '#/components/schemas/AccountIntegration' '*/*': schema: $ref: '#/components/schemas/AccountIntegration' text/csv: schema: $ref: '#/components/schemas/AccountIntegration' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountIntegration' description: '' patch: operationId: account_integration_partial_update description: Account Integration API parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity integration. required: true tags: - Account requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountIntegration' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AccountIntegration' multipart/form-data: schema: $ref: '#/components/schemas/AccountIntegration' '*/*': schema: $ref: '#/components/schemas/AccountIntegration' text/csv: schema: $ref: '#/components/schemas/AccountIntegration' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountIntegration' description: '' delete: operationId: account_integration_destroy description: Account Integration API parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity integration. required: true tags: - Account security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '204': description: No response body /api/v2/account_integration_type: get: operationId: account_integration_type_list description: |- List account integration types --- parameters: - name: page required: false type: integer paramType: query description: Desired page number of results parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: query required: false in: query description: A search term. schema: type: string tags: - Account security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAccountIntegrationTypeList' description: '' /api/v2/account_integration_type/{id}: get: operationId: account_integration_type_retrieve description: Account Integration Type API parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity integration type. required: true tags: - Account security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountIntegrationType' description: '' delete: operationId: account_integration_type_destroy description: Account Integration Type API parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this entity integration type. required: true tags: - Account security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '204': description: No response body /api/v2/action_plan: get: operationId: action_plan_list description: Retrieve Ambition Coaching Action Plans parameters: - in: query name: completed_time_end_date_time schema: type: string format: date-time description: The latest completed datetime of an item, inclusive. - in: query name: completed_time_start_date_time schema: type: string format: date-time description: The earliest completed datetime of an item, inclusive. - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: query name: due_time_end_date_time schema: type: string format: date-time description: The latest due datetime of an item, inclusive. - in: query name: due_time_start_date_time schema: type: string format: date-time description: The earliest due datetime of an item, inclusive. - in: query name: employee_id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: manager_id schema: type: number description: ID of the User that owns the item - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: query required: false in: query description: A search term. schema: type: string - in: query name: status schema: type: string enum: - all - complete - due - excused - expired - open - pending - scheduled default: all description: |2 The status of an item all: All Records. scheduled: Not Started Yet. due: Answers Due, Waiting for Answers. pending: Pending Approval, Waiting for Review. expired: Expired Before Being Completed. excused: Excused by manager. complete: Completed by All Parties. open: Action Required, Answers Due and Pending Approval. tags: - Action Plan security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedActionPlanList' description: '' /api/v2/action_plan/{id}: get: operationId: action_plan_retrieve description: Retrieve Ambition Coaching Action Plans parameters: - in: query name: completed_time_end_date_time schema: type: string format: date-time description: The latest completed datetime of an item, inclusive. - in: query name: completed_time_start_date_time schema: type: string format: date-time description: The earliest completed datetime of an item, inclusive. - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: query name: due_time_end_date_time schema: type: string format: date-time description: The latest due datetime of an item, inclusive. - in: query name: due_time_start_date_time schema: type: string format: date-time description: The earliest due datetime of an item, inclusive. - in: path name: id schema: type: integer description: A unique integer value identifying this action plan. required: true - in: query name: manager_id schema: type: number description: ID of the User that owns the item - in: query name: status schema: type: string enum: - all - complete - due - excused - expired - open - pending - scheduled default: all description: |2 The status of an item all: All Records. scheduled: Not Started Yet. due: Answers Due, Waiting for Answers. pending: Pending Approval, Waiting for Review. expired: Expired Before Being Completed. excused: Excused by manager. complete: Completed by All Parties. open: Action Required, Answers Due and Pending Approval. tags: - Action Plan security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ActionPlan' description: '' /api/v2/attribution_metric: get: operationId: attribution_metric_list description: Retrieve Ambition Coaching Program Attibution Metrics parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: query required: false in: query description: A search term. schema: type: string tags: - Program security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAttributionMetricList' description: '' /api/v2/attribution_metric/{id}: get: operationId: attribution_metric_retrieve description: Retrieve Ambition Coaching Program Attibution Metrics parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this metric config. required: true tags: - Program security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AttributionMetric' description: '' /api/v2/check_in: get: operationId: check_in_list description: Retrieve Ambition Coaching Check-Ins parameters: - in: query name: check_in_template_id schema: type: string description: ID of the Check-In Template the Check-In originated from - in: query name: co_coach_ids schema: type: array items: type: number description: IDs of User that are Co-Coaches of the Program explode: false style: form - in: query name: completed_time_end_date_time schema: type: string format: date-time description: The latest completed datetime of an item, inclusive. - in: query name: completed_time_start_date_time schema: type: string format: date-time description: The earliest completed datetime of an item, inclusive. - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: query name: due_time_end_date_time schema: type: string format: date-time description: The latest due datetime of an item, inclusive. - in: query name: due_time_start_date_time schema: type: string format: date-time description: The earliest due datetime of an item, inclusive. - in: query name: employee_id schema: type: integer - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: manager_id schema: type: number description: ID of the User that owns the item - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: program_id schema: type: string description: ID of Program Check-In is part of - in: query name: rating schema: type: number format: float description: The lowest average rating an item will have - in: query name: status schema: type: string enum: - all - complete - due - excused - expired - open - pending - scheduled default: all description: |2 The status of an item all: All Records. scheduled: Not Started Yet. due: Answers Due, Waiting for Answers. pending: Pending Approval, Waiting for Review. expired: Expired Before Being Completed. excused: Excused by manager. complete: Completed by All Parties. open: Action Required, Answers Due and Pending Approval. tags: - Check-In security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCheckInListItemList' description: '' /api/v2/check_in/{id}: get: operationId: check_in_retrieve description: Retrieve Ambition Coaching Check-Ins parameters: - in: query name: check_in_template_id schema: type: string description: ID of the Check-In Template the Check-In originated from - in: query name: co_coach_ids schema: type: array items: type: number description: IDs of User that are Co-Coaches of the Program explode: false style: form - in: query name: completed_time_end_date_time schema: type: string format: date-time description: The latest completed datetime of an item, inclusive. - in: query name: completed_time_start_date_time schema: type: string format: date-time description: The earliest completed datetime of an item, inclusive. - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: query name: due_time_end_date_time schema: type: string format: date-time description: The latest due datetime of an item, inclusive. - in: query name: due_time_start_date_time schema: type: string format: date-time description: The earliest due datetime of an item, inclusive. - in: path name: id schema: type: integer description: A unique integer value identifying this check in. required: true - in: query name: manager_id schema: type: number description: ID of the User that owns the item - in: query name: program_id schema: type: string description: ID of Program Check-In is part of - in: query name: rating schema: type: number format: float description: The lowest average rating an item will have - in: query name: status schema: type: string enum: - all - complete - due - excused - expired - open - pending - scheduled default: all description: |2 The status of an item all: All Records. scheduled: Not Started Yet. due: Answers Due, Waiting for Answers. pending: Pending Approval, Waiting for Review. expired: Expired Before Being Completed. excused: Excused by manager. complete: Completed by All Parties. open: Action Required, Answers Due and Pending Approval. tags: - Check-In security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CheckIn' description: '' /api/v2/check_in_template: get: operationId: check_in_template_list description: Retrieve Ambition Coaching Check-In Templates parameters: - in: query name: created_by_id schema: type: number description: ID of the User that created the item - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: query name: entity schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_id schema: type: number description: ID of the User that modified the item - in: query name: modified_time_end_date_time schema: type: string format: date-time description: The latest modified datetime of an item, inclusive. - in: query name: modified_time_start_date_time schema: type: string format: date-time description: The earliest modified datetime of an item, inclusive. - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: search schema: type: string tags: - Check-In security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCheckInTemplateListItemList' description: '' /api/v2/check_in_template/{id}: get: operationId: check_in_template_retrieve description: Retrieve Ambition Coaching Check-In Templates parameters: - in: query name: created_by_id schema: type: number description: ID of the User that created the item - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: path name: id schema: type: integer description: A unique integer value identifying this check in template. required: true - in: query name: modified_by_id schema: type: number description: ID of the User that modified the item - in: query name: modified_time_end_date_time schema: type: string format: date-time description: The latest modified datetime of an item, inclusive. - in: query name: modified_time_start_date_time schema: type: string format: date-time description: The earliest modified datetime of an item, inclusive. tags: - Check-In security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CheckInTemplate' description: '' /api/v2/data: get: operationId: data_list description: |- Returns a list of supported data types --- parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: query required: false in: query description: A search term. schema: type: string tags: - Data security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDepotDetailList' description: '' /api/v2/data/{data_type}: get: operationId: data_retrieve description: |- Returns a description of a data type and its schema --- type: data_schema: type: object required: true description: The schema definition for the requested data type name: type: string required: true description: The id of the data type display_name: type: string required: true description: Human readable name of the data type parameters: - name: data_type description: The id of the data type. Refer to the data types API for available types type: string required: true paramType: path parameters: - in: path name: data_type schema: type: string required: true tags: - Data security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DepotDetail' description: '' patch: operationId: data_partial_update description: Allows partial update of a data type configuration parameters: - in: path name: data_type schema: type: string required: true tags: - Data requestBody: content: application/json: schema: $ref: '#/components/schemas/DepotDetail' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DepotDetail' multipart/form-data: schema: $ref: '#/components/schemas/DepotDetail' '*/*': schema: $ref: '#/components/schemas/DepotDetail' text/csv: schema: $ref: '#/components/schemas/DepotDetail' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DepotDetail' description: '' /api/v2/group: get: operationId: group_list description: Groups parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer tags: - Group security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGroupList' description: '' post: operationId: group_create description: Groups tags: - Group requestBody: content: application/json: schema: $ref: '#/components/schemas/Group' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Group' multipart/form-data: schema: $ref: '#/components/schemas/Group' '*/*': schema: $ref: '#/components/schemas/Group' text/csv: schema: $ref: '#/components/schemas/Group' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Group' description: '' /api/v2/group/{group_id}: get: operationId: group_retrieve description: Groups parameters: - in: path name: group_id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - Group security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Group' description: '' put: operationId: group_update description: Groups parameters: - in: path name: group_id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - Group requestBody: content: application/json: schema: $ref: '#/components/schemas/Group' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Group' multipart/form-data: schema: $ref: '#/components/schemas/Group' '*/*': schema: $ref: '#/components/schemas/Group' text/csv: schema: $ref: '#/components/schemas/Group' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Group' description: '' patch: operationId: group_partial_update description: Groups parameters: - in: path name: group_id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - Group requestBody: content: application/json: schema: $ref: '#/components/schemas/Group' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Group' multipart/form-data: schema: $ref: '#/components/schemas/Group' '*/*': schema: $ref: '#/components/schemas/Group' text/csv: schema: $ref: '#/components/schemas/Group' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Group' description: '' delete: operationId: group_destroy description: Groups parameters: - in: path name: group_id schema: type: integer description: A unique integer value identifying this collection. required: true tags: - Group security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '204': description: No response body /api/v2/group/{group_id}/: get: operationId: group_list_2 description: Group Membership parameters: - in: path name: group_id schema: type: string required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: query required: false in: query description: A search term. schema: type: string tags: - Group security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGroupMemberList' description: '' post: operationId: group_create_2 description: Group Membership parameters: - in: path name: group_id schema: type: string required: true tags: - Group requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupMember' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GroupMember' multipart/form-data: schema: $ref: '#/components/schemas/GroupMember' '*/*': schema: $ref: '#/components/schemas/GroupMember' text/csv: schema: $ref: '#/components/schemas/GroupMember' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GroupMember' description: '' /api/v2/group_membership: post: operationId: group_membership_create description: Group membership bulk deleting tags: - Group requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupMemberNaturalWrite' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GroupMemberNaturalWrite' multipart/form-data: schema: $ref: '#/components/schemas/GroupMemberNaturalWrite' '*/*': schema: $ref: '#/components/schemas/GroupMemberNaturalWrite' text/csv: schema: $ref: '#/components/schemas/GroupMemberNaturalWrite' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GroupMemberNaturalWrite' description: '' delete: operationId: group_membership_destroy description: Group membership bulk deleting tags: - Group security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '204': description: No response body /api/v2/group_type: get: operationId: group_type_list description: Group Types parameters: - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: query required: false in: query description: A search term. schema: type: string tags: - Group security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGroupTypeList' description: '' post: operationId: group_type_create description: Group Types tags: - Group requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupType' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GroupType' multipart/form-data: schema: $ref: '#/components/schemas/GroupType' '*/*': schema: $ref: '#/components/schemas/GroupType' text/csv: schema: $ref: '#/components/schemas/GroupType' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GroupType' description: '' /api/v2/group_type/{name}: get: operationId: group_type_retrieve description: Group Types parameters: - in: path name: name schema: type: string required: true tags: - Group security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupType' description: '' put: operationId: group_type_update description: Group Types parameters: - in: path name: name schema: type: string required: true tags: - Group requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupTypeNoName' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GroupTypeNoName' multipart/form-data: schema: $ref: '#/components/schemas/GroupTypeNoName' '*/*': schema: $ref: '#/components/schemas/GroupTypeNoName' text/csv: schema: $ref: '#/components/schemas/GroupTypeNoName' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupTypeNoName' description: '' patch: operationId: group_type_partial_update description: Group Types parameters: - in: path name: name schema: type: string required: true tags: - Group requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupType' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/GroupType' multipart/form-data: schema: $ref: '#/components/schemas/GroupType' '*/*': schema: $ref: '#/components/schemas/GroupType' text/csv: schema: $ref: '#/components/schemas/GroupType' required: true security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupType' description: '' delete: operationId: group_type_destroy description: Group Types parameters: - in: path name: name schema: type: string required: true tags: - Group security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '204': description: No response body /api/v2/managed_program: get: operationId: managed_program_list description: Retrieve Ambition Coaching Managed Programs parameters: - in: query name: attribution_metric_ids schema: type: array items: type: number description: IDs of Attribution Metrics associated with the item explode: false style: form - in: query name: created_by_id schema: type: integer nullable: true - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: query name: entity schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: manager_ids schema: type: array items: type: number description: IDs of Users that have access to the item explode: false style: form - in: query name: modified_by_id schema: type: number description: ID of the User that modified the item - in: query name: modified_time_end_date_time schema: type: string format: date-time description: The latest modified datetime of an item, inclusive. - in: query name: modified_time_start_date_time schema: type: string format: date-time description: The earliest modified datetime of an item, inclusive. - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: search schema: type: string tags: - Program security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedManagedProgramListItemList' description: '' /api/v2/managed_program/{id}: get: operationId: managed_program_retrieve description: Retrieve Ambition Coaching Managed Programs parameters: - in: query name: attribution_metric_ids schema: type: array items: type: number description: IDs of Attribution Metrics associated with the item explode: false style: form - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: path name: id schema: type: integer description: A unique integer value identifying this program template. required: true - in: query name: manager_ids schema: type: array items: type: number description: IDs of Users that have access to the item explode: false style: form - in: query name: modified_by_id schema: type: number description: ID of the User that modified the item - in: query name: modified_time_end_date_time schema: type: string format: date-time description: The latest modified datetime of an item, inclusive. - in: query name: modified_time_start_date_time schema: type: string format: date-time description: The earliest modified datetime of an item, inclusive. tags: - Program security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ManagedProgram' description: '' /api/v2/program: get: operationId: program_list description: Retrieve Ambition Coaching Single Programs parameters: - in: query name: attribution_metric_ids schema: type: array items: type: number description: IDs of Attribution Metrics associated with the item explode: false style: form - in: query name: co_coach_ids schema: type: array items: type: number description: IDs of User that are Co-Coaches of the Program explode: false style: form - in: query name: created_by_id schema: type: integer nullable: true - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: query name: employee_ids schema: type: string - in: query name: id schema: type: integer - in: query name: is_finished schema: type: boolean - in: query name: is_started schema: type: boolean - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: managed_program_id schema: type: number description: ID of the Managed Program that controls the Program - in: query name: manager_id schema: type: number description: ID of the User that owns the item - in: query name: modified_by_id schema: type: number description: ID of the User that modified the item - in: query name: modified_time_end_date_time schema: type: string format: date-time description: The latest modified datetime of an item, inclusive. - in: query name: modified_time_start_date_time schema: type: string format: date-time description: The earliest modified datetime of an item, inclusive. - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: program_template_id schema: type: number description: ID of the Program Template the Program originated from. tags: - Program security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedProgramListItemList' description: '' /api/v2/program/{id}: get: operationId: program_retrieve description: Retrieve Ambition Coaching Single Programs parameters: - in: query name: attribution_metric_ids schema: type: array items: type: number description: IDs of Attribution Metrics associated with the item explode: false style: form - in: query name: co_coach_ids schema: type: array items: type: number description: IDs of User that are Co-Coaches of the Program explode: false style: form - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: path name: id schema: type: integer description: A unique integer value identifying this program. required: true - in: query name: managed_program_id schema: type: number description: ID of the Managed Program that controls the Program - in: query name: manager_id schema: type: number description: ID of the User that owns the item - in: query name: modified_by_id schema: type: number description: ID of the User that modified the item - in: query name: modified_time_end_date_time schema: type: string format: date-time description: The latest modified datetime of an item, inclusive. - in: query name: modified_time_start_date_time schema: type: string format: date-time description: The earliest modified datetime of an item, inclusive. - in: query name: program_template_id schema: type: number description: ID of the Program Template the Program originated from. tags: - Program security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Program' description: '' /api/v2/program_template: get: operationId: program_template_list description: Retrieve Ambition Coaching Program Templates parameters: - in: query name: attribution_metric_ids schema: type: array items: type: number description: IDs of Attribution Metrics associated with the item explode: false style: form - in: query name: created_by_id schema: type: integer nullable: true - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: query name: entity schema: type: string - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: manager_ids schema: type: array items: type: number description: IDs of Users that have access to the item explode: false style: form - in: query name: modified_by_id schema: type: number description: ID of the User that modified the item - in: query name: modified_time_end_date_time schema: type: string format: date-time description: The latest modified datetime of an item, inclusive. - in: query name: modified_time_start_date_time schema: type: string format: date-time description: The earliest modified datetime of an item, inclusive. - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: search schema: type: string tags: - Program security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedProgramTemplateListItemList' description: '' /api/v2/program_template/{id}: get: operationId: program_template_retrieve description: Retrieve Ambition Coaching Program Templates parameters: - in: query name: attribution_metric_ids schema: type: array items: type: number description: IDs of Attribution Metrics associated with the item explode: false style: form - in: query name: created_time_end_date_time schema: type: string format: date-time description: The latest created datetime of an item, inclusive. - in: query name: created_time_start_date_time schema: type: string format: date-time description: The earliest created datetime of an item, inclusive. - in: path name: id schema: type: integer description: A unique integer value identifying this program template. required: true - in: query name: manager_ids schema: type: array items: type: number description: IDs of Users that have access to the item explode: false style: form - in: query name: modified_by_id schema: type: number description: ID of the User that modified the item - in: query name: modified_time_end_date_time schema: type: string format: date-time description: The latest modified datetime of an item, inclusive. - in: query name: modified_time_start_date_time schema: type: string format: date-time description: The earliest modified datetime of an item, inclusive. tags: - Program security: - cookieAuth: [] - AmbitionTokenAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProgramTemplate' description: '' components: schemas: Account: type: object description: Ambition Account properties: is_manager: type: boolean time_zone: allOf: - $ref: '#/components/schemas/TimeZoneEnum' default: US/Eastern first_name: type: string maxLength: 64 last_name: type: string maxLength: 80 is_active: type: boolean is_org_admin: type: boolean email: type: string format: email superior: type: integer nullable: true username: type: string id: type: integer readOnly: true required: - email - first_name - id - last_name - username AccountIntegration: type: object description: Serializer for account integrations properties: account_integration_type_id: type: integer integration_uid: type: string maxLength: 128 account_id: type: integer id: type: integer readOnly: true required: - account_id - account_integration_type_id - id - integration_uid AccountIntegrationType: type: object description: Serializer for entity integration types properties: integration_id: type: integer display_name_plural: type: string maxLength: 128 name: type: string maxLength: 257 id: type: integer readOnly: true display_name: type: string maxLength: 128 required: - display_name - id - integration_id ActionItem: type: object description: Ambition Coaching Check-In Action Items properties: assignee_id: type: integer readOnly: true modified_by_id: type: integer readOnly: true modified_time: type: string format: date-time readOnly: true content: type: string is_active: type: boolean created_by_id: type: integer readOnly: true created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true completed_time: type: string format: date-time nullable: true completed_by_id: type: number readOnly: true required: - assignee_id - completed_by_id - content - created_by_id - created_time - id - modified_by_id - modified_time ActionPlan: type: object description: Ambition Coaching Action Plan properties: start_time: type: string format: date-time status: type: string readOnly: true due_time: type: string format: date-time agenda_items: type: array items: $ref: '#/components/schemas/AgendaItem' manager: $ref: '#/components/schemas/Account' employee: $ref: '#/components/schemas/Account' self: type: string format: uri readOnly: true created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true completed_time: type: string format: date-time nullable: true completed_by_id: type: number readOnly: true required: - agenda_items - completed_by_id - created_time - due_time - employee - id - manager - self - start_time - status AgendaItem: type: object description: Ambition Coaching Check-In, Program, or Template Agenda Item properties: label: type: string value: type: string id: type: integer readOnly: true type: type: string required: - id - label - type - value AttributionMetric: type: object description: Ambition Coaching Program Attribution Metric properties: source_of_truth: type: string description: type: string name: type: string maxLength: 300 self: type: string format: uri readOnly: true id: type: integer readOnly: true display_name: type: string maxLength: 128 required: - display_name - id - self - source_of_truth CheckIn: type: object description: Ambition Coaching Check-In properties: action_plan_id: type: integer readOnly: true completed_by_id: type: number readOnly: true average_rating: type: number format: double maximum: 5.0 minimum: 0.0 agenda_items: type: array items: $ref: '#/components/schemas/AgendaItem' ratings: allOf: - $ref: '#/components/schemas/Rating' readOnly: true program_attributions: allOf: - $ref: '#/components/schemas/SessionAttribution' readOnly: true manager_id: type: integer readOnly: true self: type: string format: uri readOnly: true created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true completed_time: type: string format: date-time nullable: true employee_id: type: integer readOnly: true start_time: type: string format: date-time due_time: type: string format: date-time status: type: string readOnly: true check_in_template_id: type: integer readOnly: true chosen_rating_categories: allOf: - $ref: '#/components/schemas/RatingCategory' readOnly: true program_id: type: integer readOnly: true meeting_time: type: string format: date-time nullable: true co_coach_ids: type: array items: type: integer readOnly: true name: type: string readOnly: true action_items: type: array items: $ref: '#/components/schemas/ActionItem' required: - action_items - action_plan_id - agenda_items - average_rating - check_in_template_id - chosen_rating_categories - co_coach_ids - completed_by_id - created_time - due_time - employee_id - id - manager_id - name - program_attributions - program_id - ratings - self - start_time - status CheckInListItem: type: object description: |- Ambition Coaching Check-In for lists. A subset of CheckInSerializer for performance. properties: start_time: type: string format: date-time action_plan_id: type: integer readOnly: true status: type: string readOnly: true due_time: type: string format: date-time completed_by_id: type: number readOnly: true average_rating: type: number format: double maximum: 5.0 minimum: 0.0 meeting_time: type: string format: date-time nullable: true manager_id: type: integer readOnly: true self: type: string format: uri readOnly: true created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true name: type: string readOnly: true completed_time: type: string format: date-time nullable: true employee_id: type: integer readOnly: true required: - action_plan_id - average_rating - completed_by_id - created_time - due_time - employee_id - id - manager_id - name - self - start_time - status CheckInTemplate: type: object description: Ambition Coaching Check-In Template properties: modified_by_id: type: integer readOnly: true modified_time: type: string format: date-time readOnly: true chosen_rating_categories: allOf: - $ref: '#/components/schemas/RatingCategory' readOnly: true is_active: type: boolean agenda_items: type: array items: $ref: '#/components/schemas/AgendaItem' created_by_id: type: integer readOnly: true self: type: string format: uri readOnly: true created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true name: type: string maxLength: 255 required: - agenda_items - chosen_rating_categories - created_by_id - created_time - id - modified_by_id - modified_time - name - self CheckInTemplateListItem: type: object description: |- Ambition Coaching Check-In Template for lists. A subset of CheckInTemplateSerializer for performance. properties: modified_by_id: type: integer readOnly: true modified_time: type: string format: date-time readOnly: true is_active: type: boolean created_by_id: type: integer readOnly: true self: type: string format: uri readOnly: true created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true name: type: string maxLength: 255 required: - created_by_id - created_time - id - modified_by_id - modified_time - name - self DepotDetail: type: object description: Serializer for depot detail, displays data schema in human readable form properties: data_schema: type: string readOnly: true integration_id: type: integer data_format: type: string readOnly: true name: type: string maxLength: 128 display_name: type: string maxLength: 128 required: - data_format - data_schema - display_name - integration_id Group: type: object description: |- Base ModelSerializer for Ambition. Adds support for optional fields that should not be returned unless requested. properties: id: type: integer readOnly: true name: type: string maxLength: 256 group_type: type: string required: - group_type - id - name GroupMember: type: object description: Explicitly prevents deserialization of data so as to avoid confusion about this serializer's purpose properties: username: type: string required: - username GroupMemberNaturalWrite: type: object description: Serializer composed of natural key properties: group_name: type: string username: type: string group_type: type: string required: - group_name - group_type - username GroupType: type: object description: |- Base ModelSerializer for Ambition. Adds support for optional fields that should not be returned unless requested. properties: name: type: string maxLength: 256 display_name: type: string maxLength: 256 required: - display_name - name GroupTypeNoName: type: object description: |- Base ModelSerializer for Ambition. Adds support for optional fields that should not be returned unless requested. properties: display_name: type: string maxLength: 256 required: - display_name ManagedProgram: type: object description: Ambition Coaching Managed Program properties: modified_by_id: type: integer readOnly: true is_active: type: boolean latest_session_date: type: string readOnly: true description: type: string agenda_items: type: array items: $ref: '#/components/schemas/AgendaItem' self: type: string format: uri readOnly: true created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true manager_ids: type: array items: type: integer readOnly: true modified_time: type: string format: date-time readOnly: true chosen_rating_categories: allOf: - $ref: '#/components/schemas/RatingCategory' readOnly: true objective: type: string nullable: true created_by_id: type: integer readOnly: true earliest_session_date: type: string readOnly: true attribution_metrics: type: array items: $ref: '#/components/schemas/AttributionMetric' name: type: string maxLength: 255 required: - agenda_items - attribution_metrics - chosen_rating_categories - created_by_id - created_time - earliest_session_date - id - latest_session_date - manager_ids - modified_by_id - modified_time - name - self ManagedProgramListItem: type: object description: |- Ambition Coaching Managed Program for lists. A subset of ManagedProgramSerializer for performance. properties: modified_by_id: type: integer readOnly: true modified_time: type: string format: date-time readOnly: true is_active: type: boolean name: type: string maxLength: 255 description: type: string created_by_id: type: integer readOnly: true self: type: string format: uri readOnly: true created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true objective: type: string nullable: true required: - created_by_id - created_time - id - modified_by_id - modified_time - name - self PaginatedAccountIntegrationList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/AccountIntegration' PaginatedAccountIntegrationTypeList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/AccountIntegrationType' PaginatedAccountList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/Account' PaginatedActionPlanList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/ActionPlan' PaginatedAttributionMetricList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/AttributionMetric' PaginatedCheckInListItemList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/CheckInListItem' PaginatedCheckInTemplateListItemList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/CheckInTemplateListItem' PaginatedDepotDetailList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/DepotDetail' PaginatedGroupList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/Group' PaginatedGroupMemberList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/GroupMember' PaginatedGroupTypeList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/GroupType' PaginatedManagedProgramListItemList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/ManagedProgramListItem' PaginatedProgramListItemList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/ProgramListItem' PaginatedProgramTemplateListItemList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 objects: type: array items: $ref: '#/components/schemas/ProgramTemplateListItem' Program: type: object description: Ambition Coaching Single Program properties: modified_by_id: type: integer readOnly: true employee_ids: type: array items: type: integer readOnly: true is_active: type: boolean latest_session_date: type: string readOnly: true description: type: string is_finished: type: boolean agenda_items: type: array items: $ref: '#/components/schemas/AgendaItem' managed_program_id: type: integer readOnly: true self: type: string format: uri readOnly: true created_time: type: string format: date-time readOnly: true is_started: type: boolean id: type: integer readOnly: true program_template_id: type: integer readOnly: true modified_time: type: string format: date-time readOnly: true chosen_rating_categories: allOf: - $ref: '#/components/schemas/RatingCategory' readOnly: true objective: type: string nullable: true earliest_session_date: type: string readOnly: true created_by_id: type: integer readOnly: true attribution_metrics: type: array items: $ref: '#/components/schemas/AttributionMetric' co_coach_ids: type: array items: type: integer readOnly: true name: type: string maxLength: 255 required: - agenda_items - attribution_metrics - chosen_rating_categories - co_coach_ids - created_by_id - created_time - earliest_session_date - employee_ids - id - latest_session_date - managed_program_id - modified_by_id - modified_time - name - program_template_id - self ProgramListItem: type: object description: |- Ambition Coaching Single Program for lists. A subset of ProgramSerializer for performance. properties: modified_by_id: type: integer readOnly: true modified_time: type: string format: date-time readOnly: true is_active: type: boolean name: type: string maxLength: 255 description: type: string is_finished: type: boolean created_by_id: type: integer readOnly: true managed_program_id: type: integer readOnly: true created_time: type: string format: date-time readOnly: true self: type: string format: uri readOnly: true is_started: type: boolean id: type: integer readOnly: true objective: type: string nullable: true program_template_id: type: integer readOnly: true required: - created_by_id - created_time - id - managed_program_id - modified_by_id - modified_time - name - program_template_id - self ProgramTemplate: type: object description: Ambition Coaching Program Template properties: manager_ids: type: array items: type: integer readOnly: true modified_by_id: type: integer readOnly: true modified_time: type: string format: date-time readOnly: true chosen_rating_categories: allOf: - $ref: '#/components/schemas/RatingCategory' readOnly: true is_active: type: boolean name: type: string maxLength: 255 description: type: string agenda_items: type: array items: $ref: '#/components/schemas/AgendaItem' created_by_id: type: integer readOnly: true attribution_metrics: type: array items: $ref: '#/components/schemas/AttributionMetric' self: type: string format: uri readOnly: true created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true objective: type: string nullable: true required: - agenda_items - attribution_metrics - chosen_rating_categories - created_by_id - created_time - id - manager_ids - modified_by_id - modified_time - name - self ProgramTemplateListItem: type: object description: |- Ambition Coaching Program Template for lists. A subset of ProgramTemplateSerializer for performance. properties: modified_by_id: type: integer readOnly: true modified_time: type: string format: date-time readOnly: true is_active: type: boolean name: type: string maxLength: 255 description: type: string created_by_id: type: integer readOnly: true self: type: string format: uri readOnly: true created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true objective: type: string nullable: true required: - created_by_id - created_time - id - modified_by_id - modified_time - name - self Rating: type: object description: Ambition Coaching Check-In Rating properties: created_by_id: type: integer readOnly: true value: type: string format: decimal pattern: ^\d{0,2}(?:\.\d{0,1})?$ nullable: true rating_category: $ref: '#/components/schemas/RatingCategory' check_in_id: type: integer created_time: type: string format: date-time readOnly: true id: type: integer readOnly: true required: - check_in_id - created_by_id - created_time - id - rating_category RatingCategory: type: object description: Ambition Coaching Check-In, Program, or Template Rating Category properties: label: type: string maxLength: 255 id: type: integer readOnly: true description: type: string required: - description - id - label SessionAttribution: type: object description: Ambition Coaching Check-In Attribution to a Program properties: attribution_metric: $ref: '#/components/schemas/AttributionMetric' last_updated: type: string format: date-time value: type: number format: float id: type: integer readOnly: true required: - attribution_metric - id TimeZoneEnum: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Fort_Nelson - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: string securitySchemes: AmbitionTokenAuthentication: type: apiKey in: header name: Authentication description: Value should be prepended with "Token", like "Token [TOKEN_FROM_AMBITION]" cookieAuth: type: apiKey in: cookie name: sessionid