---
title: "Get custom object schema"
method: GET
path: "/crm/custom-object-schemas/{id}"
tags: ["Custom Object Schemas"]
---

# Get custom object schema

`GET /crm/custom-object-schemas/{id}`

Get custom object schema

## Path parameters

- `id` string, required

## Query parameters

- `raw` boolean

## Headers

- `x-apideck-consumer-id` string, required
- `x-apideck-app-id` string, required
- `x-apideck-service-id` string

## Response `200`

Custom object schema

- GetCustomObjectSchemaResponse
  - `status_code` integer, required — HTTP Response Status Code
  - `status` string, required — HTTP Response Status
  - `service` string, required — Apideck ID of service provider
  - `resource` string, required — Unified API resource name
  - `operation` string, required — Operation performed
  - `data` CustomObjectSchema, required
    - `id` string — The unique identifier of the custom object schema
    - `name` string, nullable — The name of the custom object schema
    - `description` string, nullable — The description of the custom object schema
    - `fields` object[] — The fields defined in the schema
      - `id` string
      - `name` string
      - `description` string, nullable
      - `type` 'string' | 'number' | 'integer' | 'boolean' | 'date' | 'datetime' | 'currency' | 'email' | 'phone' | 'reference' | 'select' | 'multiselect'
      - `required` boolean
      - `options` object[], nullable — Options for select and multiselect types
        - `value` string
        - `label` string
      - `default_value` string, nullable — Default value for the field
    - `visible` boolean, nullable — Whether the custom object schema is visible in the UI
    - `active` boolean, nullable — Whether the custom object schema is active
    - `created_by` string, nullable — The ID of the user who created the custom object schema
    - `updated_by` string, nullable — The ID of the user who last updated the custom object schema
    - `updated_at` string, nullable — The timestamp when the custom object schema was last updated
    - `created_at` string, nullable — The timestamp when the custom object schema was created
    - `pass_through` object[] — The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
      - `service_id` string, required — Identifier for the service to which this pass_through should be applied.
      - `operation_id` string — Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request.
      - `extend_object` object — Simple object allowing any properties for direct extension.
      - `extend_paths` object[] — Array of objects for structured data modifications via paths.
        - `path` string, required — JSONPath string specifying where to apply the value.
        - `value` unknown, required
  - `meta` Meta — Response metadata
    - `items_on_page` integer — Number of items returned in the data property of the response
    - `cursors` object — Cursors to navigate to previous or next pages through the API
      - `previous` string, nullable — Cursor to navigate to the previous page of results through the API
      - `current` string, nullable — Cursor to navigate to the current page of results through the API
      - `next` string, nullable — Cursor to navigate to the next page of results through the API
    - `total_count` integer — Number of records available in total for this resource
    - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200.
      - `type` string — Discriminator for the warning kind.
      - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available.
      - `error` string, nullable — Short error description from the downstream provider, when available.
      - `operation` string, nullable — Identifier of the workflow step that failed.
      - `message` string, nullable — Detailed message from the downstream provider, when available.
  - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `404` — The specified resource was not found
- `422` — Unprocessable
- `default` — Unexpected error

---

[API](https://skmtc.net/apideck-libraries/apis/crm-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/crm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/crm-api/versions/171537af6722/schema)