> 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/introduction.md).

# Introduction

### All processes digital, smart and as simple as possible!

With EverReal you get a digital solution that not only makes your day-to-day work much easier, but also significantly increases the profitability of individual areas of responsibility in real estate management and marketing. While speed in the selection of prospects and applicants, customer satisfaction through quick reactions, ability to provide information to clients and quality levels in communication increase, error rates decrease due to uniform templates, processing time through automated processes and smart functions.

Using this API you can connect to most of the functionality that EverReal has to offer. Here are some things that you can do:

* import and update master data (owners, properties, units, tenants, bank accounts)
* create listings, add pictures, change their settings and activate them
* read candidates, contracts, protocols and other data
* book viewings in the calendar
* receive events with webhooks

### The parts of the API

All addresses use the [subdomain](https://api-docs.everreal.co/key-concepts.md#subdomain) of your partner.

| Part                    | Address                                                              | Page                                                                                 |
| ----------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| Login (OAuth 2)         | `https://{subdomain}.everreal.co/accounts/oauth/token`               | [Authentication](https://api-docs.everreal.co/master.md)                             |
| Reporting API (GraphQL) | `https://{subdomain}.everreal.co/api/reporting/graphql`              | [Endpoints](https://api-docs.everreal.co/endpoints.md)                               |
| File storage (REST)     | `https://{subdomain}.everreal.co/api/file-storage/...`               | [Document management](https://api-docs.everreal.co/endpoints/document-management.md) |
| Webhooks (REST)         | `https://{subdomain}.everreal.co/api/external-integrations/webhooks` | [Webhooks](https://api-docs.everreal.co/webhooks.md)                                 |

### Start here

1. Make a `client_id` and a `client_secret` in the EverReal web app. You must be a company admin. Open **Settings**, then **API** in the group **Integrations** (see [API ClientID and ClientSecret](https://api-docs.everreal.co/master/api-clientid-and-clientsecret.md)).
2. Get an access token (see [Authentication](https://api-docs.everreal.co/master.md)).
3. Read [Key concepts](https://api-docs.everreal.co/key-concepts.md) and the [Access model](https://api-docs.everreal.co/master/access-model.md). They explain partner, company, scope and the company of a call.
4. Read the limits: [Rate limiting](https://api-docs.everreal.co/rate-limiting.md), [Pagination](https://api-docs.everreal.co/helpers/pagination.md) and [Errors](https://api-docs.everreal.co/helpers/errors.md).

### Test environment

If you need a test environment for your integration, ask EverReal at <support@everreal.co>. You then get a test account with its own subdomain and test data, so you can try every call before you go live.

### Changes and help

The API has no version number in its address. The [Change log](https://api-docs.everreal.co/change-log.md) lists the changes. A field that will be removed is marked as deprecated in the schema first.

For help, write to <support@everreal.co>.
