> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/interfaces/withtenant.md).

# WithTenant

Interface for multi-tenant entities

Audience: Programmer

The `WithTenant` interface is implemented by entities that support multi-tenancy, allowing data isolation between different organizations or tenants.

## Fields

| Field      | Type     | Description                     |
| ---------- | -------- | ------------------------------- |
| `tenantID` | `ID!`    | Unique identifier of the tenant |
| `tenant`   | `Tenant` | Reference to the tenant entity  |

## Multi-Tenancy in pyck

pyck provides built-in multi-tenancy support where:

* Data is automatically filtered by tenant
* Queries only return data for the current tenant
* Mutations validate tenant ownership
* Cross-tenant queries require special permissions

## Implementing Types

Most core entities implement WithTenant:

* InventoryItem
* Customer
* Supplier
* Repository
* PickingOrder
* ReceivingInbound

## Usage

```graphql
# Queries automatically filter by current tenant
query {
  inventoryItems {
    edges {
      node {
        id
        sku
        tenantID  # From WithTenant interface
      }
    }
  }
}
```

## Security

* Tenant isolation is enforced at the API layer
* Users can only access their tenant's data
* Admin users may have cross-tenant access
* Tenant ID is extracted from JWT token

## Best Practices

1. Never expose tenant IDs to end users
2. Validate tenant ownership in mutations
3. Use tenant-specific caching
4. Consider tenant-specific configurations
5. Plan for data migration between tenants

## See Also

* [Authentication](/graphql-api/authentication.md) - How tenant context is established
* [Node Interface](/graphql-api/interfaces/node.md) - Base interface for entities


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/interfaces/withtenant.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.