Schema

List object types

Returns the short name, or slug, of every object in your workspace. That covers the standard CRM objects and every custom object you have set up. Use it to find the slug that goes in the {object} part of every other URL.

To see only your custom objects, call Describe Object on each slug and keep the ones where object_kind is CUSTOM. Standard objects report STANDARD.

Returns

A list of object slugs. Your custom objects sit in the same list as the standard ones.

curl 'https://api.dreamteamcrm.ai/api/v1/objects' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'

[
  "company",
  "contact",
  "deal",
  "email",
  "meeting",
  "note",
  "recording",
  "task",
  "thread",
  "subscription",
  "project"
]

Describe Object

Returns the full field schema for an object type. Always call this first before creating, updating, or filtering records - it tells you the valid field names, types, and constraints (required, unique, read-only) for each object.

{object} is the object type - contact, company, deal, note, meeting, task.

Path parameters

object string · required

Object type - one of contact, company, deal, note, meeting, task.

Returns

Object schema

curl 'https://api.dreamteamcrm.ai/api/v1/objects/contact' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'

{
  "name": "contact",
  "label": "Contact",
  "plural_label": "Contacts",
  "object_kind": "STANDARD",
  "version": 62,
  "fields": [
    {
      "name": "first_name",
      "type": "TEXT",
      "label": "First Name",
      "filterable": true,
      "read_only": false,
      "unique": false,
      "required": true
    },
    {
      "name": "email",
      "type": "EMAIL",
      "label": "Email",
      "filterable": true,
      "read_only": false,
      "unique": true,
      "required": true
    },
    {
      "name": "created_at",
      "type": "TIMESTAMP",
      "label": "Created At",
      "filterable": true,
      "read_only": true,
      "unique": false,
      "required": false
    }
  ]
}

Association Definitions

Returns the association definitions a type can participate in. Use the optional target_type query parameter to filter to definitions linking to a specific target. Reads through to the association catalog - useful for discovering valid association_name before reading links.

The association types available depend on the object. For example, contact supports company, deal, note, meeting, task. Other objects will have their own set - always call this endpoint to discover the valid types for the object you're working with.

Path parameters

object string · required

Object type - one of contact, company, deal, note, meeting, task.

Query parameters

target_type string

Optional - restrict to definitions linking to this target object type.

Returns

Association definitions

curl 'https://api.dreamteamcrm.ai/api/v1/objects/contact/associations?target_type=company' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'

[
  {
    "association_name": "company_contact_assoc",
    "label": "Company",
    "source_object": "contact",
    "target_object": "company",
    "cardinality": "MANY_TO_MANY",
    "is_default": false,
    "is_lookup": true,
    "is_active": true
  }
]