> ## Documentation Index
> Fetch the complete documentation index at: https://collabase.ch/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Collabase documentation. Interface labels are quoted in English, as they appear in the product.
> Features marked Enterprise need the Collabase Enterprise Edition licence.

# List CRM object types

> Read the types of record and their fields, relations and permissions as the CRM roles of the token owner allow.

Returns the types of record the token owner may read, with their fields. Use it to learn the short
keys a request accepts. A type the roles do not allow is missing, and so is a field the roles hide.

> [!NOTE]
>
> Scope `crm:read`. Read only: types, fields and roles are changed in the CRM app.

## Response

**data** `array` *required*

**properties**

**key** `string` *required*

The type, such as `company`, `person`, `opportunity` or the key of a custom type.

**label** `string` *required*

The name of the type.

**kind** `string` *required*

`STANDARD` or `CUSTOM`.

**permissions** `object` *required*

`create`, `update`, `delete` and `export`: what the token owner may do with this type.

**owner** `object | null` *required*

`{ "isReadOnly": boolean }`, or `null` when the roles hide the owner.

**contactPoints** `array` *required*

The kinds of contact point (`EMAIL`, `PHONE`, `DOMAIN`) the roles show, each with `isReadOnly`.

**fields** `array` *required*

Each field has `key`, `label`, `type`, `section`, `isRequired`, `isReadOnly` and `options` (the choices of a selection field, the stages of a pipeline in order).

**relations** `array` *required*

Each relation has `key`, `fromTypeKey`, `toTypeKey`, `cardinality` and `maxPerFrom`. Set one with `links` on a record.

```bash cURL theme={"dark"}
curl "https://your-collabase.ch/api/v1/crm/object-types" \
  -H "Authorization: Bearer cb_xYz123ABCD..."
```

```json 200 theme={"dark"}
{
  "data": [
    {
      "key": "company",
      "label": "Companies",
      "kind": "STANDARD",
      "permissions": { "create": true, "update": true, "delete": false, "export": false },
      "owner": { "isReadOnly": false },
      "contactPoints": [{ "kind": "DOMAIN", "isReadOnly": false }],
      "fields": [
        { "key": "annualRevenue", "label": "Annual revenue", "type": "CURRENCY", "section": "metrics", "isRequired": false, "isReadOnly": false, "options": [] }
      ],
      "relations": []
    }
  ]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.