# ShowMojo API

> Official documentation for the ShowMojo APIs: listing import and export, properties, report export, tours scheduling, and the signed Leads & Showings webhook. Tokens are generated self-serve in the ShowMojo settings.

Full contract for AI tools: https://docs.showmojo.com/llms-full.txt
Dated changelog: https://docs.showmojo.com/changelog
Versioning and deprecation policy: https://docs.showmojo.com/versioning

## Legacy API (v3)

- [ShowMojo Legacy API](https://docs.showmojo.com/docs/legacy/showmojo-legacy-api): The legacy version of the ShowMojo API provides programmatic access to core platform features. It enables clients to synchronize property listings, manage availability, and perform basic data integration with external systems.
- [Authentication](https://docs.showmojo.com/docs/legacy/authentication): OAuth2 authentication and access token retrieval
  - [Obtain OAuth2 access token](https://docs.showmojo.com/docs/legacy/obtain-access-token): POST /oauth2/token
- [Listings](https://docs.showmojo.com/docs/legacy/listings): The Listings API provides access to listing data and allows external systems to import or update rental listings in ShowMojo.
  - [Import](https://docs.showmojo.com/docs/legacy/import-listings): POST /api/v3/listings
  - [List Listings](https://docs.showmojo.com/docs/legacy/list-listings): GET /api/v3/listings
  - [Get Listing](https://docs.showmojo.com/docs/legacy/get-listing): GET /api/v3/listings/{uid}
- [Properties](https://docs.showmojo.com/docs/legacy/properties): The Properties API provides read-only access to properties associated with the authenticated account.
  - [List Properties](https://docs.showmojo.com/docs/legacy/list-properties): GET /api/v3/properties
  - [Get Property](https://docs.showmojo.com/docs/legacy/get-property): GET /api/v3/properties/{uid}
- [Report Export](https://docs.showmojo.com/docs/legacy/reports): The Report Export API allows you to fetch structured reporting data from ShowMojo in either **JSON** or **CSV** format.
  - [Named Report Export (JSON)](https://docs.showmojo.com/docs/legacy/export-report-json): POST /api/v3/reports/{report_name}
  - [Named Report Export (CSV)](https://docs.showmojo.com/docs/legacy/export-report-csv): POST /api/v3/reports/{report_name}.csv
  - [Custom Report Export (JSON)](https://docs.showmojo.com/docs/legacy/export-custom-report-json): POST /api/v3/reports/custom
  - [Custom Report Export (CSV)](https://docs.showmojo.com/docs/legacy/export-custom-report-csv): POST /api/v3/reports/custom.csv
- [Tours](https://docs.showmojo.com/docs/legacy/tours): Multi-unit availability and scheduling for tours
  - [Fetch available times for a listing](https://docs.showmojo.com/docs/legacy/get-available-tour-times): GET /api/v3/tours/{listing_id}/available_times
  - [Fetch screening questions for a listing](https://docs.showmojo.com/docs/legacy/get-screening-questions): GET /api/v3/tours/{listing_id}/screening_questions
  - [Schedule a new tour](https://docs.showmojo.com/docs/legacy/schedule-tour): PUT /api/v3/tours/schedule
  - [Fetch scheduled tour result](https://docs.showmojo.com/docs/legacy/get-tour-result): GET /api/v3/tours/results
- [Leads and Showings (webhook)](https://docs.showmojo.com/docs/legacy/leads-and-showings): The ShowMojo Webhook allows you to receive real-time notifications about lead and showing events via HTTP POST.

## API v4

- [ShowMojo API v4](https://docs.showmojo.com/docs/v4/showmojo-api-v-4): This is the v4 version of the ShowMojo API.  It is currently in active development and serves as the foundation for public and internal documentation.

## Zapier Integration API

- [Zapier Integration API](https://docs.showmojo.com/docs/zapier/zapier-integration-api): This API enables integration between Zapier and the ShowMojo platform.
- [Authentication](https://docs.showmojo.com/docs/zapier/authentication): OAuth 2.0 flow for authorizing the Zapier app with a ShowMojo account. Used only during initial account connection. Clients still sign in separately.
  - [Check OAuth2 authentication](https://docs.showmojo.com/docs/zapier/get-me): GET /zapier/me
- [Webhook Subscriptions](https://docs.showmojo.com/docs/zapier/webhook-subscriptions): Create and remove subscriptions to receive webhook events such as showing creation, cancellation, blacklisting, or screening denial.
  - [Create webhook subscription](https://docs.showmojo.com/docs/zapier/create-webhook-subscription): POST /zapier/webhook_subscriptions
  - [Delete webhook subscription](https://docs.showmojo.com/docs/zapier/delete-webhook-subscription): DELETE /zapier/webhook_subscriptions/{id}
- [Webhook Payload](https://docs.showmojo.com/docs/zapier/webhook-payload): Defines the structure of webhook payloads sent from ShowMojo to Zapier. Payloads are automatically sent to all subscribed endpoints when a matching event occurs.
- [Listings](https://docs.showmojo.com/docs/zapier/listings): Endpoints to create and update property listings on the ShowMojo platform. Only create action is available at the moment.
  - [Create new listing](https://docs.showmojo.com/docs/zapier/create-zapier-listing): POST /zapier/listings
- [Showing related events (webhook)](https://docs.showmojo.com/docs/zapier/showing-related-events): When a showing-related event occurs in your ShowMojo account, a webhook is automatically sent to all registered `target_url`s

## OpenAPI specifications

- [Legacy API (v3) (YAML)](https://docs.showmojo.com/openapi/showmojo-api-legacy.yaml)
- [Legacy API (v3) (JSON)](https://docs.showmojo.com/openapi/showmojo-api-legacy.json)
- [API v4 (YAML)](https://docs.showmojo.com/openapi/showmojo-api-v4.yaml)
- [API v4 (JSON)](https://docs.showmojo.com/openapi/showmojo-api-v4.json)
- [Zapier Integration API (YAML)](https://docs.showmojo.com/openapi/showmojo-api-zapier.yaml)
- [Zapier Integration API (JSON)](https://docs.showmojo.com/openapi/showmojo-api-zapier.json)
- [Legacy API (JSON alias)](https://docs.showmojo.com/openapi.json)