> ## 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 compliance run schema

> Returns field definitions — titles, help text, types, and defaults — for every compliance setting key. Use this to build a dynamic settings UI without hardcoding field metadata.

Field definitions for building a settings UI

**Permission:** Org **admin** only. Denials read `Manage Compliance`.

**Not callable with an API key.** Requires an org **admin**. Service accounts cannot be assigned the admin role and their role cannot be changed, so every API key gets `403`. Only a signed-in admin can call it.



## OpenAPI

````yaml /api-reference/specs/compliance.json get /api/compliance/schema
openapi: 3.1.0
info:
  title: ConveYour API — Compliance
  description: >-
    Run real-time compliance checks on contacts to confirm completed lessons and
    form submissions.
  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: []
tags:
  - name: Compliance
    description: >-
      Run real-time compliance checks on contacts to confirm completed lessons
      and form submissions.
paths:
  /api/compliance/schema:
    get:
      tags:
        - Compliance
      summary: Get compliance run schema
      description: >-
        Returns field definitions — titles, help text, types, and defaults — for
        every compliance setting key. Use this to build a dynamic settings UI
        without hardcoding field metadata.


        Field definitions for building a settings UI


        **Permission:** Org **admin** only. Denials read `Manage Compliance`.


        **Not callable with an API key.** Requires an org **admin**. Service
        accounts cannot be assigned the admin role and their role cannot be
        changed, so every API key gets `403`. Only a signed-in admin can call
        it.
      operationId: fieldDefinitionsForBuildingASettingsUi
      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/ComplianceSchemaWrapper'
              example:
                status: ok
                message: Compliance configuration schema
                data:
                  schema:
                    enabled:
                      type: boolean
                      label: Enable Compliance
                      default: false
                    lesson_tags_all:
                      type: array
                      label: Lesson Tags (All)
                      description: Lesson must have every listed tag
                    lesson_tags_any:
                      type: array
                      label: Lesson Tags (Any)
                      description: Lesson must have at least one listed tag
                    submission_enabled:
                      type: boolean
                      label: Include Form Submissions
                      default: false
        '403':
          $ref: '#/components/responses/Forbidden'
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.
    ComplianceSchemaWrapper:
      type: object
      description: >-
        The field map sits one level down under `schema`, and it describes the
        configuration rather than listing records.
      properties:
        schema:
          type: object
          description: Compliance configuration field definitions, keyed by field name.
      required:
        - schema
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  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.