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

# Get form collection schema

> Returns the field definitions for a form collection.

**Permission:** requires any of `manage_forms`, `view_form_submissions` or `create_form_submissions`. The 403 message reads `view_form_submissions`.



## OpenAPI

````yaml /api-reference/specs/form-collections.json get /api/form/collections/schema
openapi: 3.1.0
info:
  title: ConveYour API — Form Collections
  description: >-
    Form definitions — the schema a form record conforms to. Distinct from
    submission collections, which group submitted responses.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
paths:
  /api/form/collections/schema:
    get:
      tags:
        - Form Collections
      summary: Get form collection schema
      description: >-
        Returns the field definitions for a form collection.


        **Permission:** requires any of `manage_forms`, `view_form_submissions`
        or `create_form_submissions`. The 403 message reads
        `view_form_submissions`.
      operationId: getFormCollectionSchema
      parameters:
        - $ref: '#/components/parameters/teams'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ModelSchema'
        '403':
          description: Forbidden — the key lacks the required permission.
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    ModelSchema:
      type: object
      description: >-
        Wrapper object with a single `schema` key. The field map sits one level
        down under `schema`.
      properties:
        schema:
          type: object
          description: Field definitions keyed by field name.
      required:
        - schema
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

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