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

# Objects Overview

> Create custom object schemas and manage records for contacts, companies, and custom entities in the HoopAI Platform REST API.

The Objects API gives you full control over custom object schemas and their records in the HoopAI Platform. Define entirely new object types with custom labels and fields, then create, read, update, delete, and search individual records against those schemas. Standard objects — such as contacts, opportunities, and companies — are also supported, giving you a unified data layer for all entity types in your account.

## Base URL

```
https://services.leadconnectorhq.com
```

## Authentication

Every request must include a bearer token in the `Authorization` header and the API version in the `Version` header.

```http theme={null}
Authorization: Bearer <access_token>
Version: 2021-07-28
```

Use an access token generated for your account, or a Private Integration Token scoped to your account. Creating a new custom object schema requires an **admin-level** token.

## OAuth scopes

| Scope                     | Access                                    |
| ------------------------- | ----------------------------------------- |
| `objects/schema.readonly` | Read object schema definitions            |
| `objects/schema.write`    | Create and update object schemas          |
| `objects/record.readonly` | Read and search object records            |
| `objects/record.write`    | Create, update, and delete object records |

## Quick start

List all object schemas available in an account:

```bash theme={null}
curl -X GET "https://services.leadconnectorhq.com/objects/?locationId=632c34b4c9b7da3358ac9891" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28"
```

## Endpoints

| Method   | Path                                  | Description                      |
| -------- | ------------------------------------- | -------------------------------- |
| `GET`    | `/objects/`                           | Get all objects for a location   |
| `POST`   | `/objects/`                           | Create Custom Object             |
| `GET`    | `/objects/{key}`                      | Get Object Schema by key / id    |
| `PUT`    | `/objects/{key}`                      | Update Object Schema By Key / Id |
| `POST`   | `/objects/{schemaKey}/records`        | Create Record                    |
| `GET`    | `/objects/{schemaKey}/records/{id}`   | Get Record By Id                 |
| `PUT`    | `/objects/{schemaKey}/records/{id}`   | Update Record                    |
| `DELETE` | `/objects/{schemaKey}/records/{id}`   | Delete Record                    |
| `POST`   | `/objects/{schemaKey}/records/search` | Search Object Records            |

## Related

* [Custom Fields API overview](/api-reference/custom-fields/overview) — add custom field definitions to your object schemas
* [Associations API overview](/api-reference/associations/overview) — define and query relationships between object records
* [OAuth 2.0 overview](/api-reference/oauth/overview) — obtain and refresh access tokens