API Documentation

Use the Forms Live API to access forms, templates, user sessions, and more to seamlessly integrate your product into the workflows of real estate professionals across Australia.

QuickstartAuthentication

Getting started

To get started, register for an API key from the register page, then read about how to authenticate and make requests to the resources you need to access. The Forms Live API is built using standards-based HTTPS with JSON as the data-interchange format and is available across multiple Australian states.

Learn about authentication

API Features

The Forms Live API provides comprehensive access to:

  • Forms Management: Create, update, and manage real estate forms
  • Electronic Signing: Remote signing capabilities for forms
  • Templates: Access to form templates and user templates
  • File Management: Upload, download, and manage form attachments
  • User Sessions: Secure authentication and session management
  • Agency Information: Access agency and user details
  • Deep Linking: Direct links to Forms Live UI for seamless integration

Multi-State Support

Forms Live operates across multiple Australian states, each with dedicated API endpoints:

  • NSW: New South Wales real estate forms
  • VIC: Victoria real estate forms
  • QLD: Queensland real estate forms (Realworks)
  • SA, WA, TAS, NT, ACT: Additional state coverage

Each state has separate staging and production environments to support development and testing workflows.

Guides

Authentication

Learn how to authenticate your API requests.

Read more

Pagination

Understand how to work with paginated responses.

Read more

Errors

Read about the different types of errors returned by the API.

Read more

Webhooks

Learn how to programmatically configure webhooks for your app.

Read more

AI & tooling

The following machine-readable resources are available for use with AI coding assistants, API clients, and developer tooling:

  • OpenAPI Specification — OpenAPI 3.0 JSON spec covering all API endpoints, schemas, and authentication. Import directly into Postman, Swagger UI, or any OpenAPI-compatible tool.
  • Full documentation digest — The complete API documentation as a single plain-text markdown document. Paste the URL into your AI assistant to give it full context about the Forms Live API in one request.
  • llms.txt — A structured index of all documentation pages, following the llmstxt.org convention for AI tool discovery.

Resources

Forms

Learn about the form model and how to create, retrieve, update, delete, and list forms.

Templates

Learn about the template model and how to create, retrieve, update, and list form templates.

Form Files

Learn about form file management and how to upload, download, and manage form attachments.

User Templates

Learn about user-specific templates and how to create forms from custom user templates.