> ## Documentation Index
> Fetch the complete documentation index at: https://docs.serval.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Open Team Form

> Open a team's service catalog form for the caller with pre-filled answers. Returns the form's fields, current values and validation errors, plus a link to the form's service catalog page pre-filled with the same answers so the requester can review and submit it there.

## Authentication and permissions

> **Token requirements:** **User-based token (OAuth)**.
>
> Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

| Credential | Access requirements |
| - | - |
| Organization-scoped API key | Unsupported |
| Workspace-scoped API key | Unsupported |
| User-based token (OAuth) | Supported, subject to permissions |

Permissions joined by **+** are all required; **or** separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.

Only a signed-in user can open or submit a team form; API keys are refused.

* **Team form:** The form must be listed in team\_id's service catalog and available to you. Submitting creates a ticket on team\_id with you as its requester.


## OpenAPI

````yaml /sections/api-reference/openapi-spec-v2.yaml post /v2/team-forms/open
openapi: 3.1.0
info:
  title: Serval Public API
  description: Serval Public API
  contact:
    name: Serval
    url: https://serval.com
    email: support@serval.com
  license:
    name: Serval License
    url: https://serval.com/license
  version: 2.0.0
servers:
  - url: https://public.api.serval.com
security:
  - BearerAuth: []
tags:
  - name: Access Membership API
  - name: Access Policy API
  - name: Access Policy Approval Procedure API
  - name: Access Profile API
  - name: Access Relationship API
  - name: Access Request API
  - name: Agent API
  - name: Alerts API
  - name: Analytics API
  - name: App Instance API
  - name: App Resource API
  - name: App Resource Role API
  - name: Approval Delegation API
  - name: Approval Procedure API
  - name: Approval Request API
  - name: Assignment Rules API
  - name: Audit Log API
  - name: Billing API
  - name: Browser API
  - name: Campaign API
  - name: Change Blackout API
  - name: Change Model API
  - name: Connected Channels API
  - name: Custom Field API
  - name: Custom Role API
  - name: Custom Service API
  - name: Dashboards API
  - name: Email Intake API
  - name: Entity API
  - name: Entity Field Mapping API
  - name: Entity Ingestion Config API
  - name: Entity Type API
  - name: Folder API
  - name: Forms
  - name: Forms API
  - name: Group API
  - name: Guidance API
  - name: Help Agent API
  - name: Improvement Request API
  - name: Journey API
  - name: Knowledge API
  - name: Knowledge Base API
  - name: One-Time Window API
  - name: Package API
  - name: Platform Migration API
  - name: Project API
  - name: Report API
  - name: Review API
  - name: Role Sync API
  - name: Roles API
  - name: SLA API
  - name: Schedule API
  - name: Skills API
  - name: Tag API
  - name: Ticket API
  - name: Ticket Import API
  - name: Ticket Type API
  - name: Topic API
  - name: User API
  - name: User Relationship API
  - name: Widgets API
  - name: Worker API
  - name: Workflow API
  - name: Workflow Approval Procedure API
  - name: Workflow Run API
  - name: Workspace API
  - name: Workspace Group API
  - name: Workspace SDLC Settings API
  - name: Workspace User API
paths:
  /v2/team-forms/open:
    post:
      tags:
        - Forms
      summary: Open Team Form
      description: >-
        Open a team's service catalog form for the caller with pre-filled
        answers. Returns the form's fields, current values and validation
        errors, plus a link to the form's service catalog page pre-filled with
        the same answers so the requester can review and submit it there.
      operationId: svrelay.publicv2.PublicAPIServiceV2.OpenTeamForm
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/svhelp.publicapi.OpenTeamFormRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/svhelp.publicapi.OpenTeamFormResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    svhelp.publicapi.OpenTeamFormRequest:
      type: object
      properties:
        teamId:
          type: string
          title: team_id
          x-stainless-terraform-configurability: optional
        formId:
          type: string
          title: form_id
          description: A service catalog form id, as listed in the team's resources.
          x-stainless-terraform-configurability: optional
        values:
          type: object
          title: values
          additionalProperties:
            $ref: '#/components/schemas/svhelp.publicapi.HelpAgentFormValue'
            title: value
          description: |-
            Pre-filled answers keyed by field key. Values the form rejects are
             reported as field errors rather than failing the open.
          x-stainless-terraform-configurability: optional
      title: OpenTeamFormRequest
      additionalProperties: false
    svhelp.publicapi.OpenTeamFormResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/svhelp.publicapi.TeamForm'
          title: data
          x-stainless-terraform-configurability: optional
      title: OpenTeamFormResponse
      additionalProperties: false
    svhelp.publicapi.HelpAgentFormValue:
      type: object
      oneOf:
        - $ref: '#/components/schemas/svhelp.publicapi.HelpAgentFormValue.List'
        - $ref: '#/components/schemas/svhelp.publicapi.HelpAgentFormValue.Rows'
        - $ref: '#/components/schemas/svhelp.publicapi.HelpAgentFormValue.Text'
      title: HelpAgentFormValue
      description: |-
        HelpAgentFormValue is one field's value. Lists carry their members; a
         repeater's rows are JSON-encoded field maps, matching how the form engine
         stores them.
    svhelp.publicapi.TeamForm:
      type: object
      properties:
        form:
          $ref: '#/components/schemas/svhelp.publicapi.HelpAgentForm'
          title: form
          x-stainless-terraform-configurability: optional
        url:
          type: string
          title: url
          description: >-
            The form's service catalog page, pre-filled with the values given,
            for
             the requester to review and submit themselves.
          x-stainless-terraform-configurability: optional
      title: TeamForm
      additionalProperties: false
    svhelp.publicapi.HelpAgentFormValue.List:
      type: object
      title: List
      properties:
        list:
          $ref: '#/components/schemas/svhelp.publicapi.HelpAgentFormValueList'
          title: list
          x-stainless-terraform-configurability: optional
      required:
        - list
      additionalProperties: false
    svhelp.publicapi.HelpAgentFormValue.Rows:
      type: object
      title: Rows
      properties:
        rows:
          $ref: '#/components/schemas/svhelp.publicapi.HelpAgentFormValueRows'
          title: rows
          x-stainless-terraform-configurability: optional
      required:
        - rows
      additionalProperties: false
    svhelp.publicapi.HelpAgentFormValue.Text:
      type: object
      title: Text
      properties:
        text:
          type: string
          title: text
          x-stainless-terraform-configurability: optional
      required:
        - text
      additionalProperties: false
    svhelp.publicapi.HelpAgentForm:
      type: object
      properties:
        formSessionId:
          type: string
          title: form_session_id
          description: Set for a code-first form; empty for a workflow-input form.
          x-stainless-terraform-configurability: optional
        formName:
          type: string
          title: form_name
          x-stainless-terraform-configurability: optional
        ticketId:
          type: string
          title: ticket_id
          x-stainless-terraform-configurability: optional
        status:
          type: string
          title: status
          description: |-
            Engine status: in_progress while fillable, submitted once accepted.
             Terminal statuses no longer accept values.
          x-stainless-terraform-configurability: optional
        fields:
          type: array
          items:
            $ref: '#/components/schemas/svhelp.publicapi.HelpAgentFormField'
          title: fields
          x-stainless-terraform-configurability: optional
        workflowCallId:
          type: string
          title: workflow_call_id
          description: Set for a workflow-input form; empty for a code-first form.
          x-stainless-terraform-configurability: optional
      title: HelpAgentForm
      additionalProperties: false
    svhelp.publicapi.HelpAgentFormValueList:
      type: object
      properties:
        values:
          type: array
          items:
            type: string
          title: values
          x-stainless-terraform-configurability: optional
      title: HelpAgentFormValueList
      additionalProperties: false
    svhelp.publicapi.HelpAgentFormValueRows:
      type: object
      properties:
        rowsJson:
          type: array
          items:
            type: string
          title: rows_json
          x-stainless-terraform-configurability: optional
      title: HelpAgentFormValueRows
      additionalProperties: false
    svhelp.publicapi.HelpAgentFormField:
      type: object
      properties:
        key:
          type: string
          title: key
          description: Identifies the field when submitting; the key in the submit map.
          x-stainless-terraform-configurability: optional
        label:
          type: string
          title: label
          x-stainless-terraform-configurability: optional
        type:
          type: string
          title: type
          description: |-
            Field type as a lowercase name (string, number, boolean, date,
             string_list, attachment, repeater, ...). New types can appear without a
             breaking change, so treat an unrecognized type as free text.
          x-stainless-terraform-configurability: optional
        required:
          type: boolean
          title: required
          x-stainless-terraform-configurability: computed_optional
        readOnly:
          type: boolean
          title: read_only
          x-stainless-terraform-configurability: computed_optional
        description:
          type:
            - string
            - 'null'
          title: description
          x-stainless-terraform-configurability: optional
        options:
          type: array
          items:
            $ref: '#/components/schemas/svhelp.publicapi.HelpAgentFormOption'
          title: options
          description: Present for choice fields; the value is what a submit must send.
          x-stainless-terraform-configurability: optional
        value:
          oneOf:
            - $ref: '#/components/schemas/svhelp.publicapi.HelpAgentFormValue'
            - type: 'null'
          title: value
          description: >-
            The field's current value: what the agent prefilled, or what a
            previous
             submit attempt left behind.
          x-stainless-terraform-configurability: optional
        error:
          type:
            - string
            - 'null'
          title: error
          description: Set when a previous submit rejected this field.
          x-stainless-terraform-configurability: optional
        validation:
          oneOf:
            - $ref: '#/components/schemas/svhelp.publicapi.HelpAgentFormValidation'
            - type: 'null'
          title: validation
          description: >-
            The author's constraints on this field, when it declares any. A
            submit
             is checked against them, so a caller can apply the same rules up front
             rather than discovering them from a rejection.
          x-stainless-terraform-configurability: optional
      title: HelpAgentFormField
      additionalProperties: false
    svhelp.publicapi.HelpAgentFormOption:
      type: object
      properties:
        value:
          type: string
          title: value
          x-stainless-terraform-configurability: optional
        label:
          type: string
          title: label
          x-stainless-terraform-configurability: optional
        description:
          type:
            - string
            - 'null'
          title: description
          x-stainless-terraform-configurability: optional
      title: HelpAgentFormOption
      additionalProperties: false
    svhelp.publicapi.HelpAgentFormValidation:
      type: object
      properties:
        format:
          type:
            - string
            - 'null'
          title: format
          description: '"email" or "url". Checked in addition to pattern, not instead of it.'
          x-stainless-terraform-configurability: optional
        pattern:
          type:
            - string
            - 'null'
          title: pattern
          description: >-
            RE2 regular expression the value must match. An expression the
            server
             cannot compile is omitted rather than published, since a caller could
             not apply it either.
          x-stainless-terraform-configurability: optional
        message:
          type:
            - string
            - 'null'
          title: message
          description: |-
            The author's own wording for a failure, preferred over the generic
             message when the field is rejected.
          x-stainless-terraform-configurability: optional
        minLength:
          type:
            - integer
            - 'null'
          title: min_length
          format: int32
          x-stainless-terraform-configurability: optional
        maxLength:
          type:
            - integer
            - 'null'
          title: max_length
          format: int32
          x-stainless-terraform-configurability: optional
        min:
          type:
            - number
            - 'null'
          title: min
          format: double
          x-stainless-terraform-configurability: optional
        max:
          type:
            - number
            - 'null'
          title: max
          format: double
          x-stainless-terraform-configurability: optional
      title: HelpAgentFormValidation
      additionalProperties: false
      description: >-
        HelpAgentFormValidation is the subset of a field's author-declared rules
        that
         a caller can enforce itself. Absent members are unconstrained.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.