---
title: "Get a custom object type"
method: GET
path: "/custom-object-types/{typeId}"
tags: ["Settings"]
---

# Get a custom object type

`GET /custom-object-types/{typeId}`

## Request

- Base URL: `https://api.cavuno.com/v1`
- URL: `https://api.cavuno.com/v1/custom-object-types/{typeId}`
- Auth: HTTP bearer

Gets one catalog type, including archived types. Requires `settings.read`.

## Path parameters

- `typeId` string, required

## Response `200`

Catalog type.

- CustomObjectType
  - `id` string, required
  - `object` 'custom_object_type', required
  - `name` string, required
  - `key` string, required
  - `definitions` union[], required
    - union
      - ScalarProfileCustomFieldDefinition
        - `key` string, required
        - `label` string, required
        - `helpText` string
        - `type` 'short_text' | 'long_text' | 'rich_text' | 'single_select' | 'multi_select' | 'boolean' | 'number' | 'date' | 'url' | 'email' | 'phone', required
        - `required` boolean, required
        - `visibility` 'private' | 'public', required
        - `editableByOwner` boolean, required
        - `options` object[]
          - `key` string, required
          - `label` string, required
        - `min` number
        - `max` number
      - CollectionMediaFieldDefinition
        - `key` string, required
        - `label` string, required
        - `type` 'image' | 'image_gallery' | 'file', required
        - `required` boolean, required
        - `visibility` 'private' | 'public', required
        - `editableByOwner` false, required
        - `helpText` string
  - `archived` boolean, required
  - `logoFieldKey` string, nullable, required: Key of the Image field whose image is each record's logo, or null when the type has no logo field.
  - `createdAt` string, date-time, required

## Other responses

- `404`: Catalog resource not found.

## Changes

- **2026-10-19** `c34152c38176`: 1 info
  - added the optional property `error/upgrade` to the response with the `404` status

[Operation history](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/changes/custom-object-types/:typeId/get.md)

---

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