> ## 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 a form collection

> Returns a single 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/{id}
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/{id}:
    get:
      tags:
        - Form Collections
      summary: Get a form collection
      description: >-
        Returns a single form collection.


        **Permission:** requires any of `manage_forms`, `view_form_submissions`
        or `create_form_submissions`. The 403 message reads
        `view_form_submissions`.
      operationId: getFormCollection
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The form collection ID.
        - $ref: '#/components/parameters/teams'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/FormCollection'
        '403':
          description: Forbidden — the key lacks the required permission.
        '404':
          description: Not found.
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.
    FormCollection:
      type: object
      description: >-
        A form collection — the definition of a form. It carries the custom
        object fields plus a locked, required Form Name and email alert
        configuration.
      properties:
        id:
          type: string
          description: Collection ID.
        org_id:
          type: integer
          description: Owning organization.
        user_id:
          type: integer
          description: User who created it.
        name:
          type: string
          description: >-
            Form Name. Required and locked — it cannot be removed from the
            schema.
        label:
          type: string
          description: Singular human label.
        label_plural:
          type: string
          description: Plural human label.
        schema:
          type: object
          description: >-
            Field definitions for records in this collection, keyed by field
            name.
          additionalProperties:
            type: object
            properties:
              name:
                type: string
                description: Field name.
              title:
                type: string
                description: Field title.
              type:
                type: string
                description: Field type.
              validators:
                type: array
                items:
                  type: string
                description: Validator names.
        email_alerts:
          type: object
          description: >-
            Email alerts per submission stage, keyed by status. Declared as a
            NestedModel with status as the key and to as the value; defaults to
            empty.
          additionalProperties:
            type: object
            properties:
              status:
                type: string
                enum:
                  - pending
                  - completed
                description: >-
                  Submission status that triggers the alert. Defaults to
                  completed.
              to:
                type: array
                items:
                  type: string
                description: Email addresses that receive the alert. Required.
        external_id:
          type: string
          description: >-
            Unique identifier linking this to an external system. Required and
            unique.
        external_created_at:
          type: string
          description: When the record was created in the external system.
        external_updated_at:
          type: string
          description: When the record was updated in the external system.
        created_at:
          type: string
          description: Creation timestamp.
        updated_at:
          type: string
          description: Last update timestamp.
  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.