# Prophia Docs - [Welcome to Prophia](https://docs.prophia.com/index.md): Documentation for the Prophia platform, API, and MCP server - [Integration Overview](https://docs.prophia.com/developers/overview.md): Two ways to work with Prophia data: the MCP server and the REST API - [Authentication](https://docs.prophia.com/developers/authentication.md): API keys for the REST API and MCP server - [Write access](https://docs.prophia.com/developers/write-access.md): The module and capability a REST key needs before POST, PATCH, and DELETE will work - [MCP Server Overview](https://docs.prophia.com/developers/mcp/overview.md): What the Prophia MCP server is, what a connected assistant can do, and what it can't - [OAuth Setup for Your Organization](https://docs.prophia.com/developers/mcp/oauth-setup.md): One-time identity-provider configuration so your users can connect via SSO - [Connect Claude to Prophia](https://docs.prophia.com/developers/mcp/connect-claude.md): Add the Prophia MCP server to Claude Desktop or Claude Code - [Connect Other MCP Clients](https://docs.prophia.com/developers/mcp/connect-other-clients.md): Cursor and any Streamable-HTTP MCP client - [API Key Access](https://docs.prophia.com/developers/mcp/api-key-access.md): Connect to the MCP server headlessly with an API key - [Tools Reference](https://docs.prophia.com/developers/mcp/tools-reference.md): Every tool the Prophia MCP server exposes, by category - [Connect AI to These Docs](https://docs.prophia.com/developers/docs-mcp.md): Add the Prophia documentation MCP server to Claude, Cursor, or VS Code - [API Introduction](https://docs.prophia.com/api-reference/v2/introduction.md): Base URL, authentication, and where to start with the Prophia REST API - [Includes](https://docs.prophia.com/api-reference/v2/concepts/includes.md): Embed related resources in one request with the include query parameter - [Pagination, sorting, and filtering](https://docs.prophia.com/api-reference/v2/concepts/pagination-and-filtering.md): The list envelope, paging rules, sort fields, and per-resource filters - [Errors and permissions](https://docs.prophia.com/api-reference/v2/concepts/errors-and-permissions.md): Status codes, the error body, the capabilities model, and why 404 sometimes means 403 - [Data model](https://docs.prophia.com/api-reference/v2/concepts/data-model.md): How accounts, properties, buildings, spaces, leases, documents, and tags fit together - [Leases](https://docs.prophia.com/api-reference/v2/concepts/leases.md): Lease status fields, lease type, subleases, and the spaces a lease occupies - [Documents](https://docs.prophia.com/api-reference/v2/concepts/documents.md): Uploading documents, the documentStatus lifecycle, categories, and change detection - [Tags and tag values](https://docs.prophia.com/api-reference/v2/concepts/tags-and-values.md): How extracted lease terms are structured: categories, typed values, schedules, options, and amendment chains - [Tag reference](https://docs.prophia.com/api-reference/v2/concepts/tag-reference.md): Every term Prophia captures: tag names, the units they carry, space-dependence, and customValue meanings - [Spaces, applicable spaces, and encumbrances](https://docs.prophia.com/api-reference/v2/concepts/spaces-and-encumbrances.md): Building spaces, how tags reference space by name, and which spaces are burdened by options - [Understanding onboarding](https://docs.prophia.com/api-reference/v2/concepts/onboarding.md): How a building goes from an address to fully curated data — and how to tell where it is - [LIST Account](https://docs.prophia.com/api-reference/v2/accounts/list-account.md): Returns a paged list of the accounts your api key has access to. In practice API keys are granted access to a single account per api key, so the list will contain just this single account. - [GET Account](https://docs.prophia.com/api-reference/v2/accounts/get-account.md): Returns a single account by id. To retrieve a list of accounts your api key has access to, use the [list accounts endpoint](/api-reference/v2/accounts/list-account) api. - [LIST Leases Recently Updated](https://docs.prophia.com/api-reference/v2/accounts/list-leases-recently-updated.md): Returns a paged list of leases whose documents have had data updated between `start_date` and `end_date` (both inclusive), limited to buildings your api key is permitted to access. This is the change-detection primitive for sync jobs: poll it and re-fetch only the leases it names instead of re-crawl… - [LIST Property](https://docs.prophia.com/api-reference/v2/properties/list-property.md): Returns a paged list of the properties in the account. - [GET Property](https://docs.prophia.com/api-reference/v2/properties/get-property.md): Returns a single property by id. - [LIST Building](https://docs.prophia.com/api-reference/v2/properties/list-building.md): Returns a paged list of the Property's Buildings. For a list of all Buildings in the Account try this [list buildings endpoint](/api-reference/v2/buildings/list-building). - [LIST Lease](https://docs.prophia.com/api-reference/v2/properties/list-lease.md): Returns a paged list of the Leases across the Buildings in the Property. - [CREATE Property](https://docs.prophia.com/api-reference/v2/properties/create-property.md): Creates a Property in the Account. A Property is required in order to create a Building. - [UPDATE Property](https://docs.prophia.com/api-reference/v2/properties/update-property.md): Updates a single Property by id. Omitted fields are left unchanged. - [LIST Building](https://docs.prophia.com/api-reference/v2/buildings/list-building.md): Returns a paged list of the Account's Buildings - [GET Building](https://docs.prophia.com/api-reference/v2/buildings/get-building.md): Returns a single building by id. - [LIST Lease](https://docs.prophia.com/api-reference/v2/buildings/list-lease.md): Returns a paged list of the Building's Leases. - [CREATE Building](https://docs.prophia.com/api-reference/v2/buildings/create-building.md): Creates a Building under a Property in the Account. A Building is required in order to create a Lease. - [UPDATE Building](https://docs.prophia.com/api-reference/v2/buildings/update-building.md): Updates a Building's fields. Omitted fields are left unchanged. - [LIST Building Space](https://docs.prophia.com/api-reference/v2/building-spaces/list-building-space.md): Returns a paged list of the Building's spaces, archived and non-archived alike — filter with `archived=false` for current units. - [GET Building Space](https://docs.prophia.com/api-reference/v2/building-spaces/get-building-space.md): Returns a single space by id. - [CREATE Building Space](https://docs.prophia.com/api-reference/v2/building-spaces/create-building-space.md): Creates a Building Space representing a unit, space, floor, room, or area in the Building. - [UPDATE Building Space](https://docs.prophia.com/api-reference/v2/building-spaces/update-building-space.md): Updates a Building Space's fields. Omitted fields are left unchanged. - [Delete a building space](https://docs.prophia.com/api-reference/v2/building-spaces/delete-a-building-space.md): Permanently deletes a space — this is a hard delete, not an archival; to hide a space while keeping its history, PATCH `archived` to true instead. Returns 200 with an empty body. Requires the REST write module on the account; the caller must be a Prophia team member or an edit user on the account. - [GET Lease](https://docs.prophia.com/api-reference/v2/leases/get-lease.md): Returns a single Lease by id. - [LIST Document](https://docs.prophia.com/api-reference/v2/leases/list-document.md): Returns a paged list of the Lease's Documents. - [LIST Tag](https://docs.prophia.com/api-reference/v2/leases/list-tag.md): Returns a paged list of the Tags (structured lease terms) extracted from the Lease's Documents, resolved against the lease's consolidated tag view. That view is rebuilt in the background about 10 minutes after the most recent tag change on the lease and returns the previous values until then; use LI… - [LIST Raw Tag](https://docs.prophia.com/api-reference/v2/leases/list-raw-tag.md): Returns a paged list of the Lease's Tags across all of its Documents, each built from its stored row, in the same shape as LIST Tag. Skips the lease's consolidated view, so a tag change shows up immediately; nothing consolidation derives across documents is applied (amended values, consolidated rent… - [CREATE Lease](https://docs.prophia.com/api-reference/v2/leases/create-lease.md): Creates a Lease in the given Building. A Lease is required in order to create a Document - [UPDATE Lease](https://docs.prophia.com/api-reference/v2/leases/update-lease.md): Updates a Lease's fields. Omitted fields are left unchanged; `dba`, when present, cannot be blank. - [LIST Page](https://docs.prophia.com/api-reference/v2/documents/list-page.md): Returns a paged list of the Document's Pages including its geometry. - [LIST Tag](https://docs.prophia.com/api-reference/v2/documents/list-tag.md): Returns a paged list of the Tags extracted from this Document, resolved against the lease's consolidated tag view. That view is rebuilt in the background about 10 minutes after the most recent tag change on the lease and returns the previous values until then; use LIST Raw Tag to see tags as they we… - [LIST Raw Tag](https://docs.prophia.com/api-reference/v2/documents/list-raw-tag.md): Returns a paged list of this Document's Tags, each built from its stored row, in the same shape as LIST Tag. Skips the lease's consolidated view, so a tag change shows up immediately; nothing consolidation derives across documents is applied (amended values, consolidated rent schedules), and an opti… - [CREATE Document via URL](https://docs.prophia.com/api-reference/v2/documents/create-document-via-url.md): Attaches a Document to a Lease by fetching it from a presigned URL you provide. The URL must use https and its response must carry a `Content-Length`. Any file type is accepted, up to 200MB. Only documents whose `filename` ends in `.pdf` are processed into Pages and Tags; anything else is stored and… - [CREATE Document via Upload](https://docs.prophia.com/api-reference/v2/documents/create-document-via-upload.md): Uploads a Document as multipart form data and attaches it to a Lease. Any file type is accepted, up to 200MB. Only documents whose filename ends in `.pdf` are processed into Pages and Tags. To upload a document to a building or property level folder, simply use the buildingId or propertyId as the le… - [UPDATE Document](https://docs.prophia.com/api-reference/v2/documents/update-document.md): Updates a Document's fields. Omitted fields are left unchanged, and a present-but-blank `title` resets it to the original filename. `documentStatus` must be one of the account's configured statuses, matched case-sensitively, and cannot be set while the Document is still being processed. - [GET Tag](https://docs.prophia.com/api-reference/v2/tags/get-tag.md): Returns a single Tag by id, resolved against the lease's consolidated tag view when available. That view is rebuilt in the background about 10 minutes after the most recent tag change on the lease and returns the previous value until then; use GET Raw Tag to see a tag as it was just created or edite… - [GET Raw Tag](https://docs.prophia.com/api-reference/v2/tags/get-raw-tag.md): Returns a single Tag by id built from its stored row, in the same shape as GET Tag. Skips the lease's consolidated view, so a tag change shows up immediately; nothing consolidation derives across documents is applied (amended values, consolidated rent schedules), and an option's child terms are not… - [LIST Custom Term Definition](https://docs.prophia.com/api-reference/v2/custom-terms/list-custom-term-definition.md): Returns a paged list of the Account's Custom Term Definitions with usage counts populated. - [GET Custom Term Definition](https://docs.prophia.com/api-reference/v2/custom-terms/get-custom-term-definition.md): Returns a single Custom Term Definition by id, with usage counts populated. - [CREATE Custom Term Definition](https://docs.prophia.com/api-reference/v2/custom-terms/create-custom-term-definition.md): Creates a Custom Term Definition on the Account. - [UPDATE Custom Term Definition](https://docs.prophia.com/api-reference/v2/custom-terms/update-custom-term-definition.md): Updates a Custom Term Definition's fields. Omitted fields are left unchanged. - [DELETE Custom Term Definition](https://docs.prophia.com/api-reference/v2/custom-terms/delete-custom-term-definition.md): Permanently deletes a Custom Term Definition AND every Custom Tag instance created from it across the Account's Leases — this cannot be undone. - [LIST Custom Field](https://docs.prophia.com/api-reference/v2/custom-fields/list-custom-field.md): Returns a paged list of the Account's Building Custom Fields, each with its options. - [GET Custom Field](https://docs.prophia.com/api-reference/v2/custom-fields/get-custom-field.md): Returns a single Building Custom Field by id, with its options. - [LIST Custom Field Option](https://docs.prophia.com/api-reference/v2/custom-fields/list-custom-field-option.md): Returns the options of a Building Custom Field. - [GET Custom Field Option](https://docs.prophia.com/api-reference/v2/custom-fields/get-custom-field-option.md): Returns a single option of a Building Custom Field. - [CREATE Custom Field](https://docs.prophia.com/api-reference/v2/custom-fields/create-custom-field.md): Creates a Building Custom Field on the Account. A `MULTI` field is created with its options. - [CREATE Custom Field Assignment](https://docs.prophia.com/api-reference/v2/custom-fields/create-custom-field-assignment.md): Sets the field's value on each of the given Buildings, up to 200 per request. - [CREATE Custom Field Option](https://docs.prophia.com/api-reference/v2/custom-fields/create-custom-field-option.md): Adds an option to a `MULTI` Building Custom Field. - [UPDATE Custom Field](https://docs.prophia.com/api-reference/v2/custom-fields/update-custom-field.md): Renames, activates, or deactivates a Building Custom Field. Omitted fields are left unchanged. - [UPDATE Custom Field Option](https://docs.prophia.com/api-reference/v2/custom-fields/update-custom-field-option.md): Changes an option's value. Buildings assigned the option show the new value. - [DELETE Custom Field](https://docs.prophia.com/api-reference/v2/custom-fields/delete-custom-field.md): Deletes a Building Custom Field along with its options and every Building's value for it. - [DELETE Custom Field Assignment](https://docs.prophia.com/api-reference/v2/custom-fields/delete-custom-field-assignment.md): Clears the field's value from a Building. - [DELETE Custom Field Option](https://docs.prophia.com/api-reference/v2/custom-fields/delete-custom-field-option.md): Deletes an option and clears it from every Building assigned it. A `MULTI` field's last remaining option cannot be deleted. - [Beta endpoints](https://docs.prophia.com/api-reference/v2/beta.md): Endpoints for Labs features that are still changing - [LIST Loan](https://docs.prophia.com/api-reference/v2/loans/list-loan.md): Returns a paged list of the Loans in the account that the caller can see, each with its collateral buildings. Narrow to the loans secured by a property's buildings or by one building. - [GET Loan](https://docs.prophia.com/api-reference/v2/loans/get-loan.md): Returns a single Loan by id, with its collateral buildings. `status` is the processing status of the loan's documents, not whether the loan is active, matured or paid off. - [API v1 (deprecated)](https://docs.prophia.com/api-reference/v1/introduction.md) - [GET Account](https://docs.prophia.com/api-reference/v1/accounts/get-account.md): Returns an account with its properties. - [LIST Leases Recently Updated](https://docs.prophia.com/api-reference/v1/accounts/list-leases-recently-updated.md): Returns the leases on the account that have at least one document updated between `start_date` and `end_date`, inclusive. The response is a plain array, not paginated. - [GET Property](https://docs.prophia.com/api-reference/v1/properties/get-property.md): Returns a property with its buildings. - [GET Building](https://docs.prophia.com/api-reference/v1/buildings/get-building.md): Returns a building with its leases. - [GET Lease](https://docs.prophia.com/api-reference/v1/leases/get-lease.md): Returns a lease with its abstracted terms. ## OpenAPI Specs - [openapi](/api-reference/openapi.json) - [openapi](/api-reference/v1/openapi.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.