---
title: "Get object"
method: GET
path: "/crm/objects/{name}"
tags: ["crm"]
---

# Get object

`GET /crm/objects/{name}`

## Request

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

Get a CRM object.

## Path parameters

- `name` string, required

## Response `200`

Successful response

- object, nullable
  - `_id` string, required
  - `_creationTime` number, required
  - `organizationId` string, required
  - `name` string, required
  - `description` string
  - `defaultView` 'table' | 'kanban' | 'calendar' | 'timeline' | 'gallery' | 'list', required: Default view rendered for the object.
  - `sortOrder` number, required
  - `immutable` boolean, required
  - `visibility` 'workspace' | 'owner_only' | 'owner_plus_members': Who can read the object's records. Always reported as the value the object behaves as: `meeting` defaults to owner_plus_members, `calendar_event` to owner_only, anything else to workspace.
  - `icon` string
  - `viewSettings` object
  - `savedViews` object[]
  - `entryCount` number
  - `createdAt` number, required
  - `updatedAt` number, required
  - `references` union[]
    - union
      - object
        - `kind` 'crm-entry', required
        - `objectName` string, required
        - `entryId` string, required
        - `label` string, required
        - `href` string, required
        - `url` string
        - `imageUrl` string
        - `objectIcon` string
      - object
        - `kind` 'crm-object', required
        - `objectName` string, required
        - `label` string, required
        - `href` string, required
        - `url` string
        - `imageUrl` string
        - `objectIcon` string
      - object
        - `kind` 'campaign', required
        - `sequenceId` string, required
        - `label` string, required
        - `href` string, required
        - `url` string
        - `imageUrl` string
        - `objectIcon` string
  - `referenceCoverage` object
    - `returned` integer, required
    - `available` integer, required
    - `truncated` boolean, 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)