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

# Endpoints

### Interactive Playground

{% hint style="warning" %}
The API is a [GraphQL endpoint](https://graphql.org/learn/). Your query names the fields of the answer. The playground needs your [Bearer token](https://api-docs.everreal.co/key-concepts.md#access-token), as the picture below shows.
{% endhint %}

In the playground, you can run queries and mutations. Open `https://{custom_subdomain}.everreal.co/api/reporting/graphql` in your browser.

<figure><img src="https://1594188794-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MgL3i0-8YP9K1HyrHy8%2Fuploads%2FDGWIxGnd9APC8l1IKEaE%2FScreenshot%202023-01-17%20at%204.19.20%20PM.png?alt=media&amp;token=b25d8e06-6623-4c0a-9858-c5020899341a" alt=""><figcaption><p>Guide to the interactive playground</p></figcaption></figure>

The [Access model](https://api-docs.everreal.co/master/access-model.md) says who can call which operation, and in which [company](https://api-docs.everreal.co/key-concepts.md#company).

Pick an entity below to see its operations.

<table data-view="cards"><thead><tr><th></th><th data-hidden></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Users</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/account-users-members.md">Account users / members</a></td></tr><tr><td>Owners</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/owners.md">Owners</a></td></tr><tr><td>Property Group</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/property-groups.md">Property Groups</a></td></tr><tr><td>Properties</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/properties.md">Properties</a></td></tr><tr><td>Units</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/units.md">Units</a></td></tr><tr><td>Listings</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/listing.md">Listing</a></td></tr><tr><td>Candidates</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/candidates.md">Candidates</a></td></tr><tr><td>Messages</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/messages.md">Messages</a></td></tr><tr><td>Contact Activities</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/contact-activites.md">Contact Activities</a></td></tr><tr><td>Tenants</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/tenants.md">Tenants</a></td></tr><tr><td>Contracting</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/contract.md">Contract</a></td></tr><tr><td>Calendar and viewings</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/calendar-and-viewings.md">Calendar and viewings</a></td></tr><tr><td>Contacts</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/contacts.md">Contacts</a></td></tr><tr><td>Document management</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/document-management.md">Document management</a></td></tr><tr><td>Tasks</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/tasks.md">Tasks</a></td></tr><tr><td>Protocols</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/protocols.md">Protocols</a></td></tr><tr><td>Bank accounts</td><td></td><td></td><td><a href="https://api-docs.everreal.co/endpoints/bank-accounts.md">Bank Accounts</a></td></tr></tbody></table>
