---
title: "Discover CRM provider schema"
method: GET
path: "/api/integrations/crm/connections/{id}/schema"
tags: ["CRM"]
---

# Discover CRM provider schema

`GET /api/integrations/crm/connections/{id}/schema`

## Request

- Base URL: `https://api.setluca.com`
- URL: `https://api.setluca.com/api/integrations/crm/connections/{id}/schema`
- Auth: one of:
  - API key in cookie `luca.session_token`
  - API key in header `x-api-key`
  - HTTP bearer

Reads the objects and fields the connected CRM actually exposes. This is what field mapping works from.

**API key scopes:** `integrations:read`.

## Path parameters

- `id` string, uuid, required

## Headers

- `Luca-API-Version` '1'

## Response `200`

ok

- CrmProviderSchemaResponse
  - `provider` 'gohighlevel' | 'hubspot' | 'activecampaign' | 'salesforce' | 'pipedrive', required
  - `fields` object[], required
    - `key` string, required
    - `label` string, required
    - `type` 'string' | 'number' | 'boolean' | 'date' | 'enum', required
    - `resource` 'contact' | 'deal' | 'note' | 'tag' | 'owner' | 'pipeline' | 'stage'
    - `required` boolean
    - `dangerous` boolean
    - `options` string[]
  - `owners` object[], required
    - `id` string, required
    - `name` string, required
  - `pipelines` object[], required
    - `id` string, required
    - `name` string, required
    - `stages` object[], required
      - `id` string, required
      - `name` string, required
  - `tags` object[], required
    - `id` string, required
    - `name` string, required
  - `webhookEvents` string[], required
  - `sampleRecords` object[], required
  - `warnings` object[]
    - `operation` 'contact_properties' | 'custom_fields' | 'deal_pipelines' | 'owners' | 'pipelines' | 'sample_contacts' | 'tags', required
    - `reason` 'missing_account_identifier' | 'request_failed', required
  - `fetchedAt` string, required

## Other responses

- `400`: bad request
- `401`: unauthorized
- `403`: forbidden
- `404`: not found
- `409`: conflict
- `429`: rate limited
- `500`: internal error
- `503`: service unavailable

---

[API](https://skmtc.dev/setluca/apis/luca-api.md) · [All operations](https://skmtc.dev/setluca/apis/luca-api/llms.txt) · [OpenAPI document](https://skmtc.dev/setluca/apis/luca-api/revisions/90a200e4100b?raw)