---
title: "GET /get-crm-schema"
method: GET
path: "/get-crm-schema"
---

# GET /get-crm-schema

`GET /get-crm-schema`

## Request

- Base URL: `https://api.retellai.com`
- URL: `https://api.retellai.com/get-crm-schema`
- Auth: HTTP bearer

Get the contact schema of the connected CRM: the fields available on its contact object, which are the values that sync mappings can reference.

## Query parameters

- `app_id` string

## Response `200`

CRM contact schema.

- object
  - `provider` string, required: CRM provider name.
  - `fields` CRMCustomFieldSchema[], required
    - `name` string, required
    - `label` string: Display label for the field.
    - `description` string
    - `type` 'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'enum', required
    - `options` string[]: Allowed values. Required when `type` is `enum`, where a value is rejected unless it appears here; ignored for every other type.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-10-16** `ca41f0dbb297`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/retellai/apis/retell-sdk/changes/get-crm-schema/get.md)

---

[API](https://skmtc.dev/retellai/apis/retell-sdk.md) - [All operations](https://skmtc.dev/retellai/apis/retell-sdk/llms.txt) - [OpenAPI document](https://skmtc.dev/retellai/apis/retell-sdk/revisions/e482acaa292c?raw)