---
title: "List fields"
method: GET
path: "/crm/objects/{objectName}/fields"
tags: ["crm"]
---

# List fields

`GET /crm/objects/{objectName}/fields`

## Request

- Base URL: `https://www.dench.com/api/v1`
- URL: `https://www.dench.com/api/v1/crm/objects/{objectName}/fields`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

List fields for a CRM object, including read-only calculation metadata.

## Path parameters

- `objectName` string, required

## Response `200`

Successful response

- object[]
  - `_id` string, required
  - `_creationTime` number, required
  - `organizationId` string, required
  - `objectId` string, required
  - `name` string, required
  - `description` string
  - `type` 'text' | 'email' | 'phone' | 'url' | 'number' | 'boolean' | 'date' | 'richtext' | 'file' | 'user' | 'enum' | 'relation' | 'tags' | 'action', required: Field data type. `relation` needs relatedObjectName + relationshipType; `enum` uses enumValues/enumColors; `user` cells store one member userId or an array of member userIds; long prose belongs in the protected `Notes` richtext field.
  - `required` boolean, required
  - `defaultValue` string
  - `calculation` object: Read-only campaign activity boolean on people or lead (through Contact), not an expression. Cannot be required, indexed, enriched or have a default value.
    - `kind` 'campaign_activity', required
    - `metric` 'email_opened' | 'email_clicked' | 'replied' | 'linkedin_connected', required
    - `campaignId` string: Same-workspace multichannel campaign ID readable by the viewer. Omit for any accessible multichannel campaign.
  - `relatedObjectId` string
  - `relationshipType` 'many_to_one' | 'many_to_many': Relation cardinality for a `relation` field.
  - `enumValues` string[]
  - `enumColors` string[]
  - `enumMultiple` boolean
  - `sortOrder` number, required
  - `indexed` boolean
  - `createdAt` number, required
  - `updatedAt` number, required

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid authentication
- `404`: Operation or resource not found
- `500`: Server error

---

[API](https://skmtc.dev/dench/apis/dench-api.md) - [All operations](https://skmtc.dev/dench/apis/dench-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dench/apis/dench-api/revisions/4a145b38f19c?raw)