> ## 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 custom object schema

> Returns the meta-schema — the field types and options available when defining a Custom Object. Use this before creating a Custom Object to understand which field types are supported.

Get the meta-schema for field types

**Permission:** Requires `manage_custom_objects`, `manage_custom_records` **or** `custom_objects`. Denials read `View Custom Objects`.



## OpenAPI

````yaml /api-reference/specs/custom-objects.json get /api/custom/objects/schema
openapi: 3.1.0
info:
  title: ConveYour API — Custom Objects
  description: >-
    Define custom data schemas (object types) to extend ConveYour beyond its
    built-in contact model.
  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: Custom Objects
    description: >-
      Define custom data schemas (object types) to extend ConveYour beyond its
      built-in contact model.
paths:
  /api/custom/objects/schema:
    get:
      tags:
        - Custom Objects
      summary: Get custom object schema
      description: >-
        Returns the meta-schema — the field types and options available when
        defining a Custom Object. Use this before creating a Custom Object to
        understand which field types are supported.


        Get the meta-schema for field types


        **Permission:** Requires `manage_custom_objects`,
        `manage_custom_records` **or** `custom_objects`. Denials read `View
        Custom Objects`.
      operationId: getTheMetaSchemaForFieldTypes
      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'
              example:
                status: ok
                message: Custom Object schema
                data:
                  schema:
                    field_types:
                      - type: Text
                        label: Text
                      - type: TextArea
                        label: Text Area
                      - type: Number
                        label: Number
                      - type: Date
                        label: Date
                      - type: DateTime
                        label: Date & Time
                      - type: Select
                        label: Select
                      - type: Checkbox
                        label: Yes/No
                      - type: List
                        label: List
                      - type: ListSelect
                        label: List Select
                      - type: Liquid
                        label: Liquid
                      - type: Image
                        label: Image
                      - type: Relation
                        label: Relation
        '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.
    ModelSchema:
      type: object
      description: >-
        Wrapper. The field map sits one level down under `schema` — the response
        is not a list of records.
      properties:
        schema:
          type: object
          description: >-
            Field definitions keyed by field name. Each value is the field's
            definition, not a value.
          additionalProperties:
            type: object
            properties:
              type:
                type: string
                description: ConveYour field type, e.g. Text, Boolean, Array.
              validators:
                type: array
                items:
                  type: string
                description: Validator names, e.g. required, unique.
              default:
                description: Default value, when the definition declares one.
            description: Further keys vary by field type.
      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.