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

# Workspace and objects

> How a Heliyos workspace is organised: objects, their fields, and the records inside them.

## Workspace

Everything in Heliyos belongs to one **workspace**: your team, its records, notes, tasks, Scouts, workers and settings. An API key is tied to one workspace, and every request reads and writes only that workspace. [Get the workspace](https://docs.heliyos.ai/api-reference/workspace/get-the-workspace.md) returns its name, plan, member count, record counts and Watchers in use.

## Objects

An **object** is a kind of record, with its own fields. Every workspace starts with three built-in objects:

| Object | `objectType` | Holds |
| - | - | - |
| Companies | `company` | Accounts you sell to. |
| People | `people` | Contacts at those accounts. |
| Deals | `deals` | Opportunities in your pipeline. |

You can add **custom objects** for anything else you track, such as partners, projects or renewals. In the API, objects are called **base schemas**, which is why their endpoints live under `/v1/platform/base-schemas`.

```text theme={"dark"}
Workspace
├── Company (object)      fields: company_name, website, ...
│   ├── Northwind Traders (record)
│   └── Contoso (record)
├── People (object)       fields: people_name, email, ...
├── Deals (object)        fields: deal_name, ...
└── Partners (custom object)
```

You need an object's id to list or create its records. Call [List objects](https://docs.heliyos.ai/api-reference/schemas/list-objects.md) once and keep the ids: they do not change.

## Fields

Each object has **fields**. A field has a `name` (the key you use in record bodies, such as `company_name`), a `displayName` people see, and a `type`. Types include text, rich text, numbers, currency, ratings, checkboxes, dates and timestamps, single and multi select, URLs, emails, phone numbers, users, images and relationships to other objects. The [Create a field](https://docs.heliyos.ai/api-reference/schemas/create-a-field.md) page lists every type with the values it accepts.

Fields can be **AI fields**: Heliyos fills them from a prompt you set on the field.

> [!WARNING]
>
> Changing a field's key or type, or deleting a field, affects every record of that object. Read the notes on [Update a field](https://docs.heliyos.ai/api-reference/schemas/update-a-field.md) and [Delete a field](https://docs.heliyos.ai/api-reference/schemas/delete-a-field.md) before you change a field other systems depend on.

## Next

> [card] [Records and fields](https://docs.heliyos.ai/concepts/records-and-fields.md)
>
> How to read and write field values on records.

> [card] [Schemas reference](https://docs.heliyos.ai/api-reference/schemas/list-objects.md)
>
> Every object and field endpoint.


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