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

# API Reference

> Connect external AI clients and trusted services to Trellis with workspace-scoped API keys.

The Trellis API surface is focused on secure workspace access for trusted integrations. Use it when an external system needs to create, read, update, or delete Trellis operational objects, or connect an AI client to approved workspace tools.

<Warning>
  The public REST API covers CRUD access for tasks and properties, plus daily work orders and
  programmatic authentication. Other Trellis objects are available through documented MCP tools
  or by agreement with Trellis support. Do not build against undocumented endpoints.
</Warning>

## Base URL

Use the production API host:

```text theme={null}
https://api.trellistech.com
```

The hosted MCP endpoint is:

```text theme={null}
https://api.trellistech.com/v1/mcp-server
```

The public REST API endpoint is served from the Trellis app host:

```text theme={null}
https://app.trellistech.com/api/v1
```

## Authentication

Every trusted request must include a Bearer token in the `Authorization` header. Use a workspace API key for server-side integrations, or a session access token from `POST /api/v1/auth/token` for programmatic user authentication:

```bash theme={null}
curl -H "Authorization: Bearer trls_acmevaca_abc123..." \
  https://app.trellistech.com/api/v1/workspaces/acme-vacations/properties
```

See [Authentication](/api-reference/authentication) for key management, session tokens, and security guidance.

## Available integration surface

<CardGroup cols={2}>
  <Card title="Public REST API" icon="braces" href="/api-reference/public-rest-api">
    Create, read, update, and delete versioned task and property contracts with workspace API keys.
  </Card>

  <Card title="Trellis MCP Server" icon="plug" href="/api-reference/mcp-server">
    Connect MCP-compatible clients to Trellis tools.
  </Card>

  <Card title="Authentication" icon="key-round" href="/api-reference/authentication">
    Workspace API keys and programmatic session authentication.
  </Card>
</CardGroup>

## Contract versions

| Contract          | Version             |
| ----------------- | ------------------- |
| Public REST API   | `v1`                |
| API contract      | `1.4.0`             |
| OpenAPI document  | `3.1.0`             |
| Tasks object      | `tasks.v1.3.0`      |
| Properties object | `properties.v1.2.0` |

Open the interactive REST reference at [app.trellistech.com/public-docs](https://app.trellistech.com/public-docs).

## What MCP tools can access

The hosted MCP server exposes Trellis operational tools for workspace data such as tasks, properties, reservations, conversations, workforce, knowledge base, and automations. Write actions are gated by the tool contract and should be paired with explicit user confirmation in your client.

<Note>
  API keys are workspace-scoped. A key issued for one workspace cannot be used to operate on another
  workspace.
</Note>

## Status and errors

API responses use standard HTTP status codes. Include the request ID when contacting support about a specific call.

| Status | Meaning                                                                        |
| ------ | ------------------------------------------------------------------------------ |
| `200`  | Request succeeded                                                              |
| `400`  | Request was malformed                                                          |
| `401`  | API key is missing, invalid, expired, or not valid for the requested workspace |
| `403`  | Authenticated user does not have access to the requested workspace             |
| `429`  | Too many requests                                                              |
| `500`  | Unexpected server error                                                        |
