> ## Documentation Index > Fetch the complete documentation index at: https://api.veda.net/llms.txt > Use this file to discover all available pages before exploring further. # Interviews ## OpenAPI ````yaml GET /api/v1/interviews openapi: 3.1.0 info: title: VEDA API description: > The VEDA API is a unified API that provides access to various components of the VEDA HR Cloud. It simplifies the integration process by offering a single entry point for all API requests. contact: name: Eike Kempkes email: eike.kempkes@veda.net version: v1 servers: - url: https://your-environment.cloud.veda.net security: [] paths: /api/v1/interviews: get: tags: - interviews-controller operationId: getInterviews parameters: - name: interviewIds in: query required: false schema: type: array description: Return only interviews whose ID is included in this list. items: type: string format: uuid - name: interviewSessionIds in: query required: false schema: type: array description: >- Return only interviews that belong to one of the specified interview sessions. items: type: string format: uuid - name: personIds in: query required: false schema: type: array description: >- Return interviews in which any of the specified persons participates. Use roles to limit the match to specific interview roles. items: type: string format: uuid - name: roles in: query required: false schema: type: array description: >- Restrict personIds matching to the specified roles. If omitted, all roles are considered. items: type: string enum: - HOST - PARTNER - DELEGATE - name: statuses in: query required: false schema: type: array description: Return only interviews whose status is included in this list. items: type: string enum: - OPEN - FINISHED - CANCELLED - name: scheduledFrom in: query description: Return interviews scheduled on or after this date (inclusive). required: false schema: type: string format: date description: Return interviews scheduled on or after this date (inclusive). - name: scheduledTo in: query description: Return interviews scheduled on or before this date (inclusive). required: false schema: type: string format: date description: Return interviews scheduled on or before this date (inclusive). - name: dateClosedFrom in: query description: Return interviews closed on or after this date (inclusive). required: false schema: type: string format: date description: Return interviews closed on or after this date (inclusive). - name: dateClosedTo in: query description: Return interviews closed on or before this date (inclusive). required: false schema: type: string format: date description: Return interviews closed on or before this date (inclusive). - name: page in: query description: Zero-based page index (0..N) required: false schema: type: integer default: 0 minimum: 0 - name: size in: query description: The size of the page to be returned required: false schema: type: integer default: 10 minimum: 1 - name: sort in: query description: >- Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. required: false schema: type: array items: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PagedModelInterview' components: schemas: PagedModelInterview: type: object properties: content: type: array items: $ref: '#/components/schemas/Interview' page: $ref: '#/components/schemas/PageMetadata' Interview: type: object properties: id: type: string format: uuid description: Unique identifier of the interview. sessionId: type: string format: uuid description: Reference to the parent interview session (campaign), if any. title: type: string description: Title of the interview. templateLabel: type: string description: Display name of the template used for this interview. templateDescription: type: string description: Description of the template. templateTypeLabel: type: string description: Label of the template type (e.g. 'Annual Review'). hostPersonId: type: string format: uuid description: Person ID of the interviewer (host). partnerPersonId: type: string format: uuid description: Person ID of the interviewee (partner). delegatePersonId: type: string format: uuid description: Optional substitute acting on behalf of the host. status: type: string description: >- Current interview status: OPEN (in progress), FINISHED (completed by both host and partner), or CANCELLED. enum: - OPEN - FINISHED - CANCELLED hostProgress: type: number format: double description: >- Host completion progress in percent, from 0 to 100. Decimal values may occur. partnerProgress: type: number format: double description: >- Partner completion progress in percent, from 0 to 100. Decimal values may occur. scheduledFor: type: string format: date-time description: Planned start of the interview. scheduledForEnd: type: string format: date-time description: Planned end of the interview. createdAt: type: string format: date-time description: Creation timestamp. closureDate: type: string format: date description: >- Date the interview was closed. After closure, the interview becomes read-only. Host and partner ratings are set during closure and are therefore available once the interview is closed. hostRating: type: integer format: int32 description: Numeric rating given by the host. partnerRating: type: integer format: int32 description: Numeric rating given by the partner. hostRatingComment: type: string description: Free-text comment provided by the host. partnerRatingComment: type: string description: Free-text comment provided by the partner. finishedByHost: type: boolean description: >- Whether the host has completed their part of the interview. Once both host and partner are finished, the interview becomes read-only. finishedByPartner: type: boolean description: >- Whether the partner has completed their part of the interview. Once both host and partner are finished, the interview becomes read-only. doneByHost: type: boolean description: >- Whether the host has marked their part of the interview as done. This is a reversible progress flag; unlike finishedByHost, it does not require a rating and does not make the interview read-only. doneByPartner: type: boolean description: >- Whether the partner has marked their part of the interview as done. This is a reversible progress flag; unlike finishedByPartner, it does not require a rating and does not make the interview read-only. cancelDate: type: string format: date description: Cancellation date; null if not cancelled. cancelPersonId: type: string format: uuid description: Person ID of the person who cancelled the interview. cancelComment: type: string description: Reason for cancellation. categories: type: array description: >- Hierarchical interview content grouped into categories, topics, and items, including answers, goals, and user-added inputs. items: $ref: '#/components/schemas/InterviewCategory' readerIds: type: array description: Person IDs with read access to the interview. items: type: string format: uuid PageMetadata: type: object properties: size: type: integer format: int64 number: type: integer format: int64 totalElements: type: integer format: int64 totalPages: type: integer format: int64 InterviewCategory: type: object properties: index: type: integer format: int32 description: >- Display order of this category within the template. Lower values appear first. label: type: string description: Display label of the category. topics: type: array description: Topics belonging to this category, ordered by index. items: $ref: '#/components/schemas/InterviewTopic' InterviewTopic: type: object properties: index: type: integer format: int32 description: Display order of this topic within its category. heading: type: string description: Primary heading of the topic. subtitle: type: string description: Subtitle of the topic. Used as a secondary heading in the UI. description: type: string description: Detailed description or instructions for this topic. items: type: array description: Items belonging to this topic, ordered by index. items: $ref: '#/components/schemas/InterviewItem' InterviewItem: type: object properties: index: type: integer format: int32 description: Display order of this item within its topic. question: type: string description: The question text presented to host and partner. hostAnswer: description: >- Answer provided by the host. Depending on the item type, this value may be text or numeric. It is not used for items of type TARGET, which store their content in goals. partnerAnswer: description: >- Answer provided by the partner. Depending on the item type, this value may be text or numeric. It is not used for items of type TARGET, which store their content in goals. goals: type: array description: >- Goals attached to this item. Present only when the item type is TARGET; otherwise this list is empty or omitted. items: $ref: '#/components/schemas/Goal' userAddedInputs: type: array description: Additional user-added input rows on this item, ordered by index. items: $ref: '#/components/schemas/UserAddedInput' Goal: type: object properties: title: type: string description: Short title of the goal. description: type: string description: Detailed description of the goal. date: type: string format: date description: Target / due date of the goal. employeePersonId: type: string format: uuid description: Person ID of the employee this goal belongs to. managerPersonId: type: string format: uuid description: Person ID of the responsible manager. initialValue: type: number format: float description: Goal value at creation time. targetValue: type: number format: float description: Value the goal aims to reach. currentValue: type: number format: float description: >- Most recent measured value for the goal, in the same unit as initialValue and targetValue. unit: type: string description: Unit the values are measured in (e.g. %, EUR, items). editReason: type: string description: Reason associated with the most recent update to the goal. UserAddedInput: type: object properties: index: type: integer format: int32 description: Position of this entry within its item (0-based). hostValue: description: >- Value entered by the host for this user-added input. Depending on the input type, the value may be text or numeric. partnerValue: description: >- Value entered by the partner for this user-added input. Depending on the input type, the value may be text or numeric. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.