# Estactics Developers

> Build integrations on Estactics. Guides, API reference and an OpenAPI specification for the Estactics real estate CRM.

OpenAPI specification: http://localhost:4322/openapi.json

## Guides

- [Introduction](http://localhost:4322/docs/introduction.md): What you can build with the Estactics API and how it works.
- [Create an API key](http://localhost:4322/docs/api-keys.md): Create an API key in Estactics and use it to authenticate your requests.
- [Try the API in your browser](http://localhost:4322/docs/try-the-api.md): Send real requests from the API reference without writing any code.
- [Requests and responses](http://localhost:4322/docs/requests-and-responses.md): The base URL, request format and response format used by every endpoint.
- [Errors](http://localhost:4322/docs/errors.md): How the API reports errors, and what each status code means.
- [Rate limits](http://localhost:4322/docs/rate-limits.md): What happens when you send many requests in a short time.
- [Pagination](http://localhost:4322/docs/pagination.md): Read long lists page by page with limit and offset.
- [Filtering](http://localhost:4322/docs/filtering.md): Find exactly the records you need with search filters.
- [Selecting and sorting fields](http://localhost:4322/docs/selecting-and-sorting.md): Choose which fields come back, and in which order.
- [Dates and times](http://localhost:4322/docs/dates.md): The API always uses UTC for dates and times.
- [Permissions and data access](http://localhost:4322/docs/permissions.md): What an API key can reach, and how to give it the right access.
- [OpenAPI Specification](http://localhost:4322/docs/openapi.md): Download the OpenAPI specification for the Estactics API.
- [Send website leads to Estactics](http://localhost:4322/docs/website-leads.md): Create a client each time someone fills in a form on your website.
- [Keep properties in sync](http://localhost:4322/docs/sync-properties.md): Keep your website or portal up to date with your Estactics listings.
- [Upload property files](http://localhost:4322/docs/upload-property-files.md): Add photos and documents to a property.
- [Zapier and Make](http://localhost:4322/docs/zapier-and-make.md): Connect Estactics to other apps without writing code.
- [Frequently asked questions](http://localhost:4322/docs/faq.md): Quick answers about the Estactics API.
- [Common errors](http://localhost:4322/docs/common-errors.md): Specific error messages and how to fix them.

## API keys

- [List API keys](http://localhost:4322/reference/apitokens-getuserapitokens.md)
- [Create an API key](http://localhost:4322/reference/apitokens-createuserapitoken.md)
- [Update an API key](http://localhost:4322/reference/apitokens-updateuserapitoken.md)
- [Get API key permissions](http://localhost:4322/reference/apitokens-gettokenpermissions.md)
- [List permissions you can assign](http://localhost:4322/reference/apitokens-getuserallowedpermissions.md)
- [Rotate an API key](http://localhost:4322/reference/apitokens-rotateuserapitoken.md)
- [Delete an API key](http://localhost:4322/reference/apitokens-removeuserapitoken.md)

## Activities

- [Create an activity](http://localhost:4322/reference/activities-create.md)
- [Update an activity](http://localhost:4322/reference/activities-update.md)
- [Delete an activity](http://localhost:4322/reference/activities-remove.md)
- [Search activities](http://localhost:4322/reference/activities-search.md)
- [Count activities](http://localhost:4322/reference/activities-searchcount.md)
- [List activity types](http://localhost:4322/reference/activities-getactivitiestypesdisplaylist.md)

## Brands

- [Create a brand](http://localhost:4322/reference/brands-create.md)
- [Update a brand](http://localhost:4322/reference/brands-update.md)
- [Search brands](http://localhost:4322/reference/brands-search.md)
- [Count brands](http://localhost:4322/reference/brands-searchcount.md)
- [List brands for a picker](http://localhost:4322/reference/brands-getdisplaylist.md)
- [Upload a brand logo](http://localhost:4322/reference/brands-updatebrandlogo.md)
- [Delete a brand logo](http://localhost:4322/reference/brands-removebrandlogo.md)
- [Upload a brand icon](http://localhost:4322/reference/brands-updatebrandicon.md)
- [Delete a brand icon](http://localhost:4322/reference/brands-removebrandicon.md)

## Calendar events

- [Create a calendar event](http://localhost:4322/reference/calendarevents-create.md)
- [Update a calendar event](http://localhost:4322/reference/calendarevents-update.md)
- [Delete a calendar event](http://localhost:4322/reference/calendarevents-remove.md)
- [Search calendar events](http://localhost:4322/reference/calendarevents-search.md)
- [Count calendar events](http://localhost:4322/reference/calendarevents-searchcount.md)

## Client settings

- [Get client settings](http://localhost:4322/reference/clientssettings-fetch.md)
- [Update client settings](http://localhost:4322/reference/clientssettings-update.md)

## Clients

- [Create a client](http://localhost:4322/reference/clients-create.md)
- [Update a client](http://localhost:4322/reference/clients-update.md)
- [Move a client to a brand or team](http://localhost:4322/reference/clients-modifyclientcategorization.md)
- [Change the agent of a client](http://localhost:4322/reference/clients-changeclientassignee.md)
- [Delete a client](http://localhost:4322/reference/clients-remove.md)
- [Search clients](http://localhost:4322/reference/clients-search.md)
- [Count clients](http://localhost:4322/reference/clients-searchcount.md)
- [Get a client profile](http://localhost:4322/reference/clients-getclientprofile.md)
- [List clients for a picker](http://localhost:4322/reference/clients-getclientsdisplaylist.md)
- [List interest types](http://localhost:4322/reference/clients-getinteresttypesdisplaylist.md)
- [List purchase purposes](http://localhost:4322/reference/clients-getpurchasepurposesdisplaylist.md)

## Contacts

- [Create a contact](http://localhost:4322/reference/contacts-create.md)
- [Update a contact](http://localhost:4322/reference/contacts-update.md)
- [Delete a contact](http://localhost:4322/reference/contacts-remove.md)
- [Search contacts](http://localhost:4322/reference/contacts-search.md)
- [Count contacts](http://localhost:4322/reference/contacts-searchcount.md)
- [List contact types](http://localhost:4322/reference/contacts-getcontactstypesdisplaylist.md)

## Dashboards

- [Get resource totals](http://localhost:4322/reference/dashboards-getresourcescount.md)
- [Get the sales pipeline](http://localhost:4322/reference/dashboards-getsalespipeline.md)
- [Get recently assigned clients](http://localhost:4322/reference/dashboards-getrecentlyassignedclients.md)
- [Get client activity over time](http://localhost:4322/reference/dashboards-getclientactivities.md)
- [Get clients per agent](http://localhost:4322/reference/dashboards-getagentsclients.md)
- [Get unassigned clients](http://localhost:4322/reference/dashboards-getunassignedclients.md)
- [Get team engagements](http://localhost:4322/reference/dashboards-getteamengagements.md)
- [Get campaign performance](http://localhost:4322/reference/dashboards-getcampaignsperformance.md)
- [Get a campaign overview](http://localhost:4322/reference/dashboards-getcampaignoverview.md)

## Developers

- [Create a developer](http://localhost:4322/reference/developers-create.md)
- [Update a developer](http://localhost:4322/reference/developers-update.md)
- [Delete a developer](http://localhost:4322/reference/developers-remove.md)
- [Search developers](http://localhost:4322/reference/developers-search.md)
- [Count developers](http://localhost:4322/reference/developers-searchcount.md)
- [List developers for a picker](http://localhost:4322/reference/developers-getdisplaylist.md)
- [Upload a developer logo](http://localhost:4322/reference/developers-updatedeveloperlogo.md)
- [Delete a developer logo](http://localhost:4322/reference/developers-removedeveloperlogo.md)
- [Upload a developer icon](http://localhost:4322/reference/developers-updatedevelopericon.md)
- [Delete a developer icon](http://localhost:4322/reference/developers-removedevelopericon.md)

## Email senders

- [Create an email sender](http://localhost:4322/reference/emailsenders-create.md)
- [Update an email sender](http://localhost:4322/reference/emailsenders-update.md)
- [Delete an email sender](http://localhost:4322/reference/emailsenders-remove.md)
- [Search email senders](http://localhost:4322/reference/emailsenders-search.md)
- [Count email senders](http://localhost:4322/reference/emailsenders-searchcount.md)
- [List email senders for a picker](http://localhost:4322/reference/emailsenders-getdisplaylist.md)

## Email templates

- [Search email templates](http://localhost:4322/reference/emailtemplates-search.md)
- [Count email templates](http://localhost:4322/reference/emailtemplates-searchcount.md)
- [List email channels and topics](http://localhost:4322/reference/emailtemplates-getemailchannelstopics.md)
- [Preview an email](http://localhost:4322/reference/emailtemplates-getpreviewemaillayout.md)
- [Create email templates](http://localhost:4322/reference/emailtemplates-createchanneltopicgrouptemplates.md)
- [Update email templates](http://localhost:4322/reference/emailtemplates-updatechanneltopicgrouptemplates.md)
- [Add a template language](http://localhost:4322/reference/emailtemplates-addchanneltopicgrouptemplatelanguage.md)
- [Delete an email template](http://localhost:4322/reference/emailtemplates-remove.md)

## Emails

- [Search emails](http://localhost:4322/reference/emails-search.md)
- [Count emails](http://localhost:4322/reference/emails-searchcount.md)

## External agents

- [Create an external agent](http://localhost:4322/reference/externalagents-create.md)
- [Update an external agent](http://localhost:4322/reference/externalagents-update.md)
- [Delete an external agent](http://localhost:4322/reference/externalagents-remove.md)
- [Search external agents](http://localhost:4322/reference/externalagents-search.md)
- [Count external agents](http://localhost:4322/reference/externalagents-searchcount.md)
- [List external agents for a picker](http://localhost:4322/reference/externalagents-getdisplaylist.md)
- [Upload an external agent photo](http://localhost:4322/reference/externalagents-updateexternalagentprofilephoto.md)
- [Delete an external agent photo](http://localhost:4322/reference/externalagents-removeexternalagentprofilephoto.md)

## Labels

- [Create a label](http://localhost:4322/reference/labels-create.md)
- [Update a label](http://localhost:4322/reference/labels-update.md)
- [Delete a label](http://localhost:4322/reference/labels-remove.md)
- [Search labels](http://localhost:4322/reference/labels-search.md)
- [Count labels](http://localhost:4322/reference/labels-searchcount.md)
- [List labels for a picker](http://localhost:4322/reference/labels-getorglabelsdisplaylist.md)

## Lead registrations

- [List registrations of a client](http://localhost:4322/reference/leadsregistrations-getclientregistrationssources.md)

## Marketing campaigns

- [Create a campaign](http://localhost:4322/reference/marketingcampaigns-create.md)
- [Update a campaign](http://localhost:4322/reference/marketingcampaigns-update.md)
- [Delete a campaign](http://localhost:4322/reference/marketingcampaigns-remove.md)
- [Search campaigns](http://localhost:4322/reference/marketingcampaigns-search.md)
- [Count campaigns](http://localhost:4322/reference/marketingcampaigns-searchcount.md)
- [Upload a campaign image](http://localhost:4322/reference/marketingcampaigns-updatecampaignimage.md)
- [Delete a campaign image](http://localhost:4322/reference/marketingcampaigns-removecampaignimage.md)
- [List campaign types](http://localhost:4322/reference/marketingcampaigns-gettypesdisplaylist.md)
- [List campaign platforms](http://localhost:4322/reference/marketingcampaigns-getplatformsdisplaylist.md)
- [List campaign statuses](http://localhost:4322/reference/marketingcampaigns-getstatusesdisplaylist.md)

## Organization

- [Get your organization](http://localhost:4322/reference/organizations-getmyorganization.md)
- [Update your organization](http://localhost:4322/reference/organizations-update.md)
- [Get plan usage and limits](http://localhost:4322/reference/organizations-getorganizationusagelimits.md)

## Properties

- [Create a property](http://localhost:4322/reference/properties-create.md)
- [Clone a property](http://localhost:4322/reference/properties-clone.md)
- [Update a property](http://localhost:4322/reference/properties-update.md)
- [Delete a property](http://localhost:4322/reference/properties-remove.md)
- [Search properties](http://localhost:4322/reference/properties-search.md)
- [Count properties](http://localhost:4322/reference/properties-searchcount.md)
- [List properties for a picker](http://localhost:4322/reference/properties-getpropertiesdisplaylist.md)
- [Get a file upload URL](http://localhost:4322/reference/properties-getfileuploadurl.md)
- [Confirm uploaded documents](http://localhost:4322/reference/properties-confirmpropertyfilesuploaded.md)
- [Rename a document](http://localhost:4322/reference/properties-renamepropertyfilename.md)
- [Arrange document folders](http://localhost:4322/reference/properties-arrangefilesfolders.md)
- [Delete a document](http://localhost:4322/reference/properties-removepropertyfile.md)
- [Get a document download link](http://localhost:4322/reference/properties-getpropertyfileauthenticatedlink.md)
- [List property types](http://localhost:4322/reference/properties-getpropertiestypesdisplaylist.md)
- [List deal types](http://localhost:4322/reference/properties-getdealtypesdisplaylist.md)
- [List property statuses](http://localhost:4322/reference/properties-getstatusesdisplaylist.md)
- [List construction stages](http://localhost:4322/reference/properties-getconstructionstagesdisplaylist.md)
- [List property features](http://localhost:4322/reference/properties-getpropertyfeaturesdisplaylist.md)
- [List furnished options](http://localhost:4322/reference/properties-getfurnishedoptionsdisplaylist.md)
- [List orientations](http://localhost:4322/reference/properties-getorientationoptionsdisplaylist.md)
- [List energy ratings](http://localhost:4322/reference/properties-getenergyefficiencyoptionsdisplaylist.md)
- [List document folders](http://localhost:4322/reference/properties-getpropertyfilesfoldersdisplaylist.md)

## Roles

- [Create a role](http://localhost:4322/reference/permissionsroles-create.md)
- [Clone a role](http://localhost:4322/reference/permissionsroles-clone.md)
- [Update a role](http://localhost:4322/reference/permissionsroles-update.md)
- [Set role permissions](http://localhost:4322/reference/permissionsroles-setrolepermissions.md)
- [Delete a role](http://localhost:4322/reference/permissionsroles-remove.md)
- [Search roles](http://localhost:4322/reference/permissionsroles-search.md)
- [Count roles](http://localhost:4322/reference/permissionsroles-searchcount.md)
- [List roles for a picker](http://localhost:4322/reference/permissionsroles-getdisplaylist.md)
- [Get role allowed permissions](http://localhost:4322/reference/permissionsroles-getroleallowedpermissions.md)

## Stages

- [Create a stage](http://localhost:4322/reference/stages-create.md)
- [Update a stage](http://localhost:4322/reference/stages-update.md)
- [Delete a stage](http://localhost:4322/reference/stages-remove.md)
- [Reorder stages](http://localhost:4322/reference/stages-updatestagesorder.md)
- [List stages](http://localhost:4322/reference/stages-getorgstages.md)
- [List stage categories](http://localhost:4322/reference/stages-getstagescategoriesdisplaylist.md)

## Teams

- [Create a team](http://localhost:4322/reference/hierarchies-create.md)
- [Update a team](http://localhost:4322/reference/hierarchies-update.md)
- [Delete a team](http://localhost:4322/reference/hierarchies-remove.md)
- [Search teams](http://localhost:4322/reference/hierarchies-search.md)
- [Get the team tree](http://localhost:4322/reference/hierarchies-getorghierarchiestreeview.md)
- [List teams for a picker](http://localhost:4322/reference/hierarchies-getdisplaylist.md)
- [List your teams](http://localhost:4322/reference/hierarchies-getusernestedhierarchiesdisplaylist.md)
- [List your child teams](http://localhost:4322/reference/hierarchies-getuserhierarchieschildsdisplaylist.md)

## Users

- [Get the current user](http://localhost:4322/reference/users-getcurrentuser.md)
- [Update the current user](http://localhost:4322/reference/users-updatecurrentuserprofile.md)
- [Get user settings](http://localhost:4322/reference/users-getcurrentusersettings.md)
- [Save user settings](http://localhost:4322/reference/users-setcurrentusersettings.md)
- [Invite a user](http://localhost:4322/reference/users-inviteuser.md)
- [Resend an invitation](http://localhost:4322/reference/users-resenduserinvitelink.md)
- [Update a user](http://localhost:4322/reference/users-update.md)
- [Activate or deactivate a user](http://localhost:4322/reference/users-activateuser.md)
- [Delete a user](http://localhost:4322/reference/users-remove.md)
- [Search users](http://localhost:4322/reference/users-search.md)
- [Count users](http://localhost:4322/reference/users-searchcount.md)
- [List users for a picker](http://localhost:4322/reference/users-getdisplaylist.md)
- [List users by name](http://localhost:4322/reference/users-getusersdisplaylistbynames.md)
- [List teammates](http://localhost:4322/reference/users-getuserhierarchyteammatesdisplaylist.md)
- [Upload a user photo](http://localhost:4322/reference/users-updateuserprofilephoto.md)
- [Delete a user photo](http://localhost:4322/reference/users-removeuserprofilephoto.md)
- [Upload your photo](http://localhost:4322/reference/users-updatecurrentuserprofilephoto.md)
- [Delete your photo](http://localhost:4322/reference/users-removecurrentuserprofilephoto.md)