---
title: "Every custom object type this workspace has defined"
method: GET
path: "/v1/object-types"
tags: ["custom objects"]
---

# Every custom object type this workspace has defined

`GET /v1/object-types`

## Request

- Base URL: `https://api.indraft.io`
- URL: `https://api.indraft.io/v1/object-types`
- Auth: HTTP bearer

The custom object types this workspace has defined, with their fields and relationships. Canonical types (company, contact, opportunity, interaction, task) are not here: they are in get_crm_schema and mean the same thing in every workspace.

## Response `200`

Success

- object
  - `objectTypes` object[], required
    - `key` string, required
    - `displayName` string, required
    - `displayNamePlural` string, required
    - `idPrefix` string, required
    - `identity` object, required
      - `field` string, required
      - `normalize` string, required
    - `pendingIdentity` object, required
      - `field` string, required
      - `normalize` string, required
    - `fields` object[], required
      - `key` string, required
      - `label` string, required
      - `valueType` string, required
      - `required` boolean
      - `indexed` boolean
      - `enumOptions` string[]
    - `relationships` object[]
      - `name` string, required
      - `label` string, required
      - `target` string, required
      - `cardinality` string, required
    - `archivedAt` string, required
    - `pipelines` object[]
      - `id` string, required
      - `name` string, required
      - `stages` object[], required
        - `id` string, required
        - `name` string, required
        - `stageKind` 'open' | 'won' | 'lost', required
        - `position` integer, required
  - `requestId` string, required

## Other responses

- `401`: No credential, or one that has been revoked.
- `403`: Authenticated, and this capability is not held.
- `429`: Infrastructure protection tripped. This is not a product quota.
- `500`: A defect on our side. The hint says so, and carries an incident id.

---

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