API docs by Redocly

API Immodvisor (1.12.0)

Download OpenAPI specification:Download

Support: assistance@Immodvisor.com

Terms of use

The terms of use gather all the rules to follow to use the Immodvisor API.

Technical side

Your API key and the grains of salt of the checksums must remain secret, they represent your private parameters. It is strictly forbidden to communicate them to third parties. For security reasons, if one of these rules is not respected, we would be forced to deactivate your API key.

Advices

It is strongly recommended to use cache if you are using the API to display your rating and reviews on your site. This will ensure that the display of your page does not depend on the API responses and therefore does not affect its display time.

Display the notices on your media

On your website:

You must clearly display the source of the reviews, namely Immodvisor. Thus, the Immodvisor logo or the seal of trust must clearly appear on the page displaying the reviews, with a link in the href, scanned by search engines, and pointing to the company file of the Immodvisor site. This point is essential for search engines to make the link between the 2 pages, and avoid duplication of content. The review pages of your site must be validated by our marketing department before going into production. You must also display a textual mention indicating that the reviews come from the Immodvisor site.

Our marketing department can be reached at 09 81 10 75 88 or by email at assistance@Immodvisor.com

On other communication supports:

You must always display the Immodvisor logo and indicate that the reviews are from the Immodvisor solution.

Display Rich Snippets in google results on your url

Rich Snippets give the promise to the internet user to be able to read reviews. Any page displaying Rich Snippets in google must display the stars, as well as a link to the company's Immodvisor page. All these elements must match. For example, you can display the Rich Snippets of the company on the home page, and the Rich Snippets of each agency on your respective agency pages. Strong recommendation: a given Rich Snippet should only be placed on one and only one web page. Good to know: Rich Snippets tell Google's search engine a rating related to a web page. Google decides whether or not displaying the note in its search results is relevant to your web page. Immodvisor cannot influence Google's willingness to display or not the indicators sent by your site.

Field Order Requirement in requests

In requests, the order of fields is crucial for successful processing. Ensure that fields are sent in the exact sequence specified in the documentation; any deviation in order may result in errors. Please follow the defined field structure precisely to avoid issues.

Checksum

For each call to the API, a checksum must be sent. This checksum is calculated as follows:

Concatenation of the following values, all formatted in SHA1 :

  • apikey
  • values of parameters sent in the order specified in the doc, formatted in JSON for arrays and objects.
  • checksum_salt_in

PHP code example

private function calcChecksumIn($api_key, $checksum_salt_in, $datas = array())
    {
        $checksum = "";
        $checksum .= $api_key;
        foreach ($datas as $k => $v) {
            if (is_array($v) || is_object($v)) {
                $v = json_encode($v, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
            } elseif ($v === true) {
                $v = 1;
            } elseif ($v === false) {
                $v = 0;
            }
            $checksum .= $v;
        }
        $checksum .= $checksum_salt_in;
        return sha1($checksum);
    }

company

company informations

get company's informations

Retrieve all company's informations. If neither of the two identifiers is provided, then the company linked to the API key is returned.

Authorizations:
apikey
query Parameters
id
integer

Immodvisor ID

custom_id
integer

Company's personalized identifier.

nbr_reviews
integer

last notices' number to return. Possible values : 0 : default value, tags nbr_reviews and reviews are not returned. -1 : all reviews are sent [int] : last reviews sent last number

checksum
required
string

Request's validity's checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Company's list

Retrieve brand's companies informations in addition with brand's informations. Also retrieves the last N reviews for each company

Note: {COMPANY} objects in this service do not return richsnippets information.

Limitation : only a company of type 'brand' is allowed to call this service.

Authorizations:
apikey
query Parameters
nbr_reviews
integer

Last notices' number to return per company. By default 0, maximum 5. To retrieve previous notices, see the reviewList() service. This parameter adds an array of reviews objects to the return.

enable
boolean
Default: true

if true returns only active companies, if false returns all companies. True by default.

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": [
    ],
  • "checksum": "string"
}

Company's rich snippet code

Retrieves the Rich Snippets code to embed directly on the company page of your website. No additional processing is required. Only active companies have Rich Snippets.

Limitation: only a 'brand' company is allowed to call this service.

Authorizations:
apikey
query Parameters
checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Create company

Create a new company of type 'company'.

Warning, the specific Google elements, for example :google_attributes, cannot be added when creating the agency via the api. Indeed, a reconciliation with the Google record of the agency must first be done by Immodvisor. To update this type of value, use the updatecompany endpoint. When the value presence_management=1, the reconciliation with the Google record is effective.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
custom_id
string

your's unique identifier

name
required
string

company's name

short_name
string

company's short name, useful in case the name exceeds 50 characters

rsac
string

Company's RSAC

siret
string

Company's SIRET

enable
boolean

company enable

activities
Array of integers

Company's activities list

phone
string

contact's phone

fax
string

company's fax

email
string

contact's email address

website
string

Company's url

address
string

mailing address

address2
string

additional address

zipcode
string

zipcode

city
required
string

city

department
string

French departement code for the company’s address. Only applicable when the country is France (FR).

country
string

The country of the company’s address, using ISO 3166-1 alpha-2 codes. Optional, defaults to "FR". Possibles values are "BE", "CH", "ES", "FR", "LU", "MA", "MC", "MU", "PT".

language
string

The company’s language, used for communications such as review requests. Optional, defaults to "fr". Allowed values are "fr", "en", and "pt".

hide_city
boolean

if true, the company city will not be visible on immodvisor.com

hide_address
boolean

if true, the company address will not be visible on immodvisor.com

content
string

Company's description on immodvisor.com (HTML format)

color
string

color of the window on Immodvisor.com

facebook_page
string

Facebook's url page

twitter_page
string

Twitter's url page

instagram_page
string

Instagram's url page

linkedin_page
string

Linkedin's url page

pinterest_page
string

Pinterest's url page

tiktok_page
string

TikTok's url page

youtube_page
string

Youtube's url page

object

Company's opening hours

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Update company

Updating a company.

Note : To not update a data, just don't send it. To empty a data, you must send an empty or null value. The fields 'name', 'city' and 'department' cannot be emptied, because they are mandatory for the proper functioning of the Immodvisor site.

Warning, the treatments linked to presence management are done asynchronously, it is therefore normal not to recover updated data during an update.

Warning, for array elements, the whole element must be sent during the update. The elements not sent will be set to null.

At least one of the two identifiers must be sent.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
id
integer
custom_id
string
visible
boolean

public record visible or not

name
string

company's name

short_name
string

company's short name, useful in case the name exceeds 50 characters

rsac
string

Company's RSAC

siret
string

Company's SIRET

enable
boolean

Company enable

activities
Array of integers

Company's activities list

phone
string

contact's phone

fax
string

company's fax

email
string

contact's email address

website
string

Company's url

address
string

mailing address

address2
string

additional address

zipcode
string

zipcode

city
string

city

department
string

French departement code for the company’s address. Only applicable when the country is France (FR).

country
string

The country of the company’s address, using ISO 3166-1 alpha-2 codes. Optional, defaults to "FR". Possibles values are "BE", "CH", "ES", "FR", "LU", "MA", "MC", "MU", "PT".

language
string

The company’s language, used for communications such as review requests. Optional, defaults to "fr". Allowed values are "fr", "en", and "pt".

hide_city
boolean

if true, the company city will not be visible on immodvisor.com

hide_address
boolean

if true, the company address will not be visible on immodvisor.com

content
string

Company's description on immodvisor.com (HTML format)

color
string

color of the window on Immodvisor.com

facebook_page
string

Facebook's url page

twitter_page
string

Twitter's url page

instagram_page
string

Instagram's url page

linkedin_page
string

Linkedin's url page

pinterest_page
string

Pinterest's url page

tiktok_page
string

TikTok's url page

youtube_page
string

Youtube's url page

object

Company's opening hours

Array of objects (service_area)

Company's intervention area

google_description
string

Google My Business' description

short_description
string

Presence management's short description

long_description
string

Presence management's long description

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

add service to company

Adds an activity/service to your company.

Note : this endpoint is only valid for companies of type 'company'. You can find possible services' list by querying the activity endpoint. It is recommended to define 3 or 4.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
id
integer

unique Immodvisor company ID to update (company or brand). optional if custom_id present.

custom_id
string

Your unique company's identifier to update (company or brand). Optional if id present.

service_id
required
integer

Service's identifier to be added

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

delete service from company

Delete an activity/service from your company.

Note : this endpoint is only valid for companies of type 'company'.

Authorizations:
apikey
query Parameters
id
integer

unique Immodvisor company ID to update (company or brand). optional if custom_id present.

custom_id
string

Your unique company's identifier to update (company or brand). Optional if id present.

service_id
required
integer

Service's identifier to be added

checksum
required
string

Request's validity's checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

add partner to company

Add a partner to the company's web page.

**Note: this endpoint is only valid for companies of type 'company'.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: multipart/form-data
id
integer

unique Immodvisor company ID to update (company or brand). optional if custom_id present.

custom_id
string

Your unique company's identifier to update (company or brand). Optional if id present.

type
string
Enum: "immodvisor" "external"

immodvisor or external, specifies if it is a partner customer of Immodvisor or other

url
string

url of the public file for the type immodvisor, optional parameter otherwise

logo
string <binary>

Logo's file, mandatory for the external type, useless otherwise.

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

delete partner from company

Delete a partner from the company's web page.

**Note: this endpoint is only valid for companies of type 'company'.

Authorizations:
apikey
query Parameters
id
integer

unique Immodvisor company ID to update (company or brand). optional if custom_id present.

custom_id
string

Your unique company's identifier to update (company or brand). Optional if id present.

type
string
Enum: "immodvisor" "external"

immodvisor or external, specifies if it is a partner customer of Immodvisor or other

url
string

url of the public file for the type immodvisor, optional parameter otherwise

index
integer

only for type external, position of the element to be deleted in the list of external partners received via the endpoint company/get

checksum
required
string

Request's validity's checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

add media to company

Add a media to the company. Note : if this endpoint is called with the type logo or background and there is already a photo filled in, the existing photo will be overwritten. For the gallery type, the media is added afterwards.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: multipart/form-data
id
integer

unique Immodvisor company ID to update (company or brand). optional if custom_id present.

custom_id
string

Your unique company's identifier to update (company or brand). Optional if id present.

category
string
Enum: "logo" "background" "gallery"

media category to add among logo, background and gallery

type
string
Enum: "photo" "video"

only for the photo or video gallery category

url
string

Video's url. Only for the gallery category and the video type. Are accepted the url Youtube, Dailymotion, Vimeo and Matterport.

photo
string <binary>

photo to add, useless for the gallery category with the video type

all
boolean

only for the gallery category and the 'brand' companies. If true, will be displayed on all child companies.

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

delete media from company

Delete a media from a company

Authorizations:
apikey
query Parameters
id
integer

unique Immodvisor company ID to update (company or brand). optional if custom_id present.

custom_id
string

Your unique company's identifier to update (company or brand). Optional if id present.

category
string
Enum: "logo" "background" "gallery"

media category to add among logo, background and gallery

index
integer

Index of the item to be deleted in the company's media list. Only for the gallery type.

checksum
required
string

Request's validity's checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Replace Google attibuts of company

Allow adding attributes to the Google listing.

Warning, the new Google attributes cancel and replace the previous ones.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
id
integer

unique Immodvisor company ID to update (company or brand). optional if custom_id present.

custom_id
string

Your unique company's identifier to update (company or brand). Optional if id present.

attributes
required
Array of objects

Google attribute table. To get the list of Google attributes see the endpoint : getactivity. example : attributes[has_wheelchair_accessible_entrance]=true The type of value to send for each attribute is specified in the endpoint.

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

pro

management of the company's employees

get pro's informations

Retrieves all pro's informations associated with the company linked to the key, or associated with at least one of the companies in the fleet managed by the brand.

Authorizations:
apikey
query Parameters
id
required
integer

Immodvisor unique identifier of the pro account

custom_id
string

your's unique identifier

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Get pros' list

Retrieves all pros' informations associated with the company linked to the key, or associated with at least one of the companies in the fleet managed by the brand.

Authorizations:
apikey
query Parameters
company_id
required
integer

Immodvisor company ID (company or brand)

company_custom_id
string

Your unique company's ID (company or brand).

enable
boolean

If 'true', only get activated pros in the activated companies too. 'true' by default.

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": [
    ],
  • "checksum": "string"
}

create pro

Creation of a new professional account, directly associated with a company in the park. The professional will automatically receive his login information by email.

info : For brands only, it is mandatory to provide either the company_id or the company_custom_id. For 'company' type companies, these 2 parameters are useless because the pro will be automatically associated to the company linked to the API key.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
company_id
integer

Company's Immodvisor's ID (company or grand) to which pro account will be associate.

company_custom_id
integer

Your unique company's ID (company or brand).

email
required
string

e-mail pro, use for login

custom_id
string

your's unique identifier

enable
boolean

company enable

firstname
string

firstname

lastname
string

lastname

job
string

job

phone
string

contact's phone

mobile
string

mobile phone.

address
string

mailing address

address2
string

additional address

zipcode
string

zipcode

city
string

city

language
string <= 3 characters

pro language (ISO code 639-1). Possible values are 'fr', 'en', 'pt'. Default value is 'fr'.

acl_aapp
required
boolean

authorization to use the Immodvisor PRO application

acl_pro
required
boolean

access rights to the PRO area

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

update pro

Update a pro account. If the email address is modified, the professional will receive an email informing him/her of his/her new login information.

Note : To not update a data, just don't send it. To empty a data, you must send an empty or null value. The fields 'email', 'acl_aapp' and 'acl_pro' cannot be emptied, because they are mandatory for the proper functioning of the Immodvisor site.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
id
required
integer

unique Immodvisor identifier of the pro

custom_id
string

your's unique identifier

email
string

e-mail pro, use for login

enable
boolean

company enable

firstname
string

firstname

lastname
string

lastname

job
string

job

phone
string

contact's phone

mobile
string

mobile phone.

address
string

mailing address

address2
string

additional address

zipcode
string

zipcode

city
string

city

language
string <= 3 characters

pro language (ISO code 639-1). Possible values are 'fr', 'en', 'pt'. Default value is 'fr'.

acl_aapp
boolean

access authorization to the Immodvisor PRO application

acl_pro
boolean

access authorization to the PRO area

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Associate a pro to a company

Associate a pro account to a company. An account can be associated with several companies in the park, and has the same acl_aapp and acl_pro rights for all these companies.

Limitation : only a company of type 'brand' is authorized to call this service.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
id
required
integer

Pro's Immodvisor's unique identifier to associate.

custom_id
string

Your unique pro's identifier to dissociate.

company_id
integer

Company's Immodvisor's unique identifier to associate.

company_custom_id
string

Your unique company's identifier to associate.

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

separate a pro from a company

Disassociates a pro account from a company. If the pro is only associated with a company, this link cannot be broken.

Limitation : only a company of type 'brand' is authorized to call this service.

Authorizations:
apikey
query Parameters
id
required
integer

Pro's Immodvisor's unique identifier to dissociate.

custom_id
string

Your unique pro's identifier to dissociate.

company_id
integer

unique Immodvisor company ID to be dissociated

company_custom_id
string

Your unique company's identifier to dissociate.

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

review

management of reviews

Get company's reviews list

Retrieves reviews from one or all companies in the park.

All inputs work as filters. For companies of type 'company', the first 2 inputs are useless.

Tip: Save the reviews in your data system, via an automated script that retrieves only the reviews of the period not yet retrieved, for example week by week, or month by month.

Authorizations:
apikey
query Parameters
company_id
integer

unique Immodvisor company ID

company_custom_id
string

Your unique company's ID.

date_start
string

start date of the search (YYYY-MM-DD : year + month + day). The date indicated is included. If the start date is not indicated, then it takes the value of the date of creation of the company on Immodvisor.

date_stop
string

Search's end date (same format accepted). If the end date is not filled in, then it takes the value of the current date.

date_filter
string
Value: "update"

Defines on which fields the dates are filtered :

  • If not specified, filters dates based on the validation date
  • If 'update', filters dates based on the last modification date (either validation, update or answer)
picking
boolean

Filter reviews awaiting proof.

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": [
    ],
  • "checksum": "string"
}

List of rejected or archived reviews

Returns rejected or archived reviews from one or all companies in the park. Helps you retrieve reviews that should no longer be displayed. If the company_id is not filled in, then the notices returned will correspond to the rejected or archived notices of the brand or company associated with the API key.

Authorizations:
apikey
query Parameters
company_id
integer

unique Immodvisor identifier of the company

checksum
required
string

request's validity checksum

header Parameters
APIVERSION
required
string

API's used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": [
    ],
  • "checksum": "string"
}

send request for an reviews

Create an email collection for a customer. This service allows you to collect reviews one by one as soon as a transaction is registered in your systems. The collection sends an email invitation to the customer, and in case no review is filed, an automatic reminder is sent 7 days later.

For brands, provide either company_id or company_custom_id. A review cannot be filed on a brand.

If the contact has a review or request that is less than 15 days old, the collection will be blocked.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
company_id
integer

Immodvisor company ID

company_custom_id
integer

Your unique company's ID.

email
required
string

Customer's email

mobile
string

Customer's mobile number. If filled in, the recipient will receive an SMS request instead of an email, unless the request type is specified. Furthermore, if this field is not filled in and an SMS reminder should be sent, it will be sent by email instead.

firstname
string

Customer's firstname

lastname
string

Customer's lastname

pro_id
integer

Immodvisor identifier of the professional at the origin of the notice

pro_custom_id
string

Your pro's identifier who created the notice. If your collaborator IDs are registered with Immodvisor, you can use your own IDs instead of the Immodvisor IDs

activity_id
integer

The company's business line concerned by the notification. By default the first business of the company. If the company has only one job it is useless to fill this value.

highlight_number
integer

number of highlight linked to the job. If the highlights are activated on the company and they have been defined, you can transmit the highlight number that will be associated with the notification so that the notification questionnaire takes the parameters of the highlight and the statistics of the highlight are updated. The highlight numbers can be found in your Pro Area, under the heading "Highlights".

custom_ref
string <= 40 characters

Your solicitation reference. You can transmit an internal reference for each solicitation, which will then be returned in the notices returned by the API. Allowed characters: numbers, lower case letters, upper case letters, hyphens and underscores.

folder_id
integer

Immodvisor identifier of the file

folder_ref
string <= 45 characters

Reference of the file/program to which the notice is to be attached. If this reference is known, the link will be established, otherwise the file will be created.

lang
string
Enum: "fr" "en" "pt"

Language associated with the collection for translation of the email and the deposit. If this is not specified, it will be determined either by the mobile code, if specified, or by the company's default selection.

collect_type
string

The desired collection method. Possible value: email, sms, link.

Tip : As soon as a mobile number is sent, the API will send an SMS to your customer. If you want to send an email, just don't specify the customer's mobile. Link will return a link to put a new review.

send_google
boolean

The request will redirect the contact to a Google review submission form, if the company has a google_place_id. In this case, the parameters 'default' are unusable, and the parameters 'pro', 'highlight', 'activity' will only be attached upon request.

reminder_type
string

The desired request method for the reminder. Possible value: email, sms.

reminder_delay
integer

The desired request delay, in hours, min. 1, for the reminder.

default_rating
integer

The default rating used to pre-filled a deposit review.

default_description
string

The default comment used to pre-filled a deposit review.

default_title
string

The default title used to pre-filled a deposit review.

default_answer_survey
Array of arrays

The default answers used to pre-filled a deposit review.

checksum
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

multiple send request for reviews

Launch a collection of reviews on several customers. This service works in the same way as the collectreview service except that it allows several simultaneous sendings, and that the sendings are asynchronous. This service is ideal for collecting reviews at regular intervals (e.g. collecting reviews every 1st of each month for the previous month's customers).

For brands, provide either company_id or company_custom_id.

If the contact has a review or request that is less than 15 days old, the collection will be blocked.

Limitation: maximum 500 submissions per call

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
required
Array of objects <= 500 items
checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Add an answer to a review

This service allows you to respond to a review.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's used version.

Request Body schema: application/x-www-form-urlencoded
review_id
required
integer

unique Immodvisor identifier of the review

answer
required
string

text of the answer

job
string <= 80 characters

profession of the professional who provides the answer

signature
string <= 80 characters

signature of the professional who provides the answer

checksum
required
string

request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Edit an answer to a review

This service allows you to respond to a review.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's used version.

Request Body schema: application/x-www-form-urlencoded
answer_id
required
integer

unique Immodvisor identifier of the answer

answer
string

text of the answer

job
string <= 80 characters

profession of the professional who provides the answer

signature
string <= 80 characters

signature of the professional who provides the answer

checksum
required
string

request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Add an evidence

This service allows you to add evidence to a review.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's used version.

Request Body schema: application/x-www-form-urlencoded
review_id
required
integer

unique Immodvisor identifier of the review

file
required
string <binary>

js object of the file to upload

checksum
required
string

request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": { },
  • "checksum": "string"
}

team

management of teams

Get company's teams list

Return company or brand teams list.

Authorizations:
apikey
query Parameters
company_id
integer

unique Immodvisor company ID

company_custom_id
string

Your unique company's ID. (unused if 'company_id' is present)

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": [
    ],
  • "checksum": "string"
}

get team's informations

get team's informations

Authorizations:
apikey
query Parameters
id
required
integer

team Immodvisor login

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

create team for company

Create a new team. Once the team is created, you can add / remove professionals from the linkpro and unlinkpro methods.

At least one of the two company IDs must be transmitted.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
company_id
integer

Immodvisor identify of the company on which to create a team

company_custom_id
string

Your company's ID to create a team.

name
string

team's name

custom_id
string

team's ID

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

update team

Update of a team. Only the data entered are updated.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
id
integer

Team's identifier to be modified.

name
string

team's name

custom_id
string

team's ID

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

delete team

delete team

Authorizations:
apikey
query Parameters
id
required
integer

Team's ID to delete.

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Associate a pro to a team

Associate a professional with a team. A professional can be associated to several teams.

If a custom_id or pro_custom_id field is filled in, it must be correct for the action to be executed.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
id
required
integer

Team's ID.

custom_id
string

your team ID

pro_id
required
string

Pro's identifier to associate.

pro_custom_id
string

Yours unique Pro's identifier to associate.

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Dissociate a pro from a team.

Dissociate a pro from a team.

If a custom_id or pro_custom_id field is filled in, it must be correct for the action to be executed.

Authorizations:
apikey
query Parameters
id
required
integer

team Immodvisor login

custom_id
string

your team ID

pro_id
required
integer

Pro's identifier to dissociate.

pro_custom_id
string

Your unique pro's identifier to dissociate.

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

google

management of reviews Google

Google reviews' send request

Note: This endpoint is deprecated. It is better to use the ‘/review/collect’ endpoint with the ‘send_google’ parameter.

Create a collection for a customer. This service allows you to collect reviews on google one by one as soon as a transaction is registered in your systems. The collection sends an invitation by email or sms to the customer, with an automatic reminder sent 7 days later.

For brands, provide either company_id or company_custom_id. A notice cannot be filed on a brand.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
company_id
integer

unique Immodvisor company ID

company_custom_id
string

Your unique company's ID.

email
required
string

Customer's email.

mobile
string

Customer's mobile number. If present, the customer will receive a texting message instead of an email.

firstname
string

Customer's firstname

lastname
string

Customer's lastname

type
string
Enum: "mail" "sms"

The default value is 'mail', if the value is 'sms' the mobile parameter becomes mandatory.

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Google reviews' multiple send request

Note: This endpoint is deprecated. It is better to use the ‘/review/collectmultiple’ endpoint with the ‘send_google’ parameter.

Launch a collection of google requests on several customers. This service works in the same way as the google collect service except that it allows several simultaneous sends, and that the sends are asynchronous.

Important : the service can return a Success even if all the sendings could not be done. You have to process the response to see the details of the sendings.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
required
Array of objects <= 500 items
checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Get company's Googlereviews list

Retrieves Google reviews from one or all companies in the park.

All inputs work as filters. For companies of type 'company', the first 2 inputs are useless.

Authorizations:
apikey
query Parameters
company_id
integer

unique Immodvisor company ID

company_custom_id
string

Your unique company's ID.

date_start
string

start date of the search (YYYY-MM-DD : year + month + day). The date indicated is included. If the start date is not indicated, then it takes the value of the date of creation of the company on Immodvisor.

date_stop
string

Search's end date (same format accepted). If the end date is not filled in, then it takes the value of the current date.

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": [
    ],
  • "checksum": "string"
}

folder

management of folders

get folder's informations

Retrieve folder's informations.

Authorizations:
apikey
query Parameters
id
required
integer

Folder's identifier.

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

get folders list

Return folders list from a company on Immodvisor.

Authorizations:
apikey
query Parameters
company_id
integer

unique Immodvisor company ID

company_custom_id
string

Your unique company's identifier (can be used instead of company_id if it is filled in on Immodvisor).

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": [
    ],
  • "checksum": "string"
}

create folder

Create a new folder/program.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
company_id
integer

Immodvisor company ID on which to create a folder

company_custom_id
string

Your company's ID to create a folder.

name
string

folder's name

reference
string

folder's ID

status
string
Enum: "in progress" "completed"

folder's status

start_date
string

Folder's launch date (MM/YYYY)

end_date
string

folder's closing date MM/YYYY

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

update folder

Update a folder/program. Only the data entered are updated.

Authorizations:
apikey
header Parameters
APIVERSION
required
string

API's Used version.

Request Body schema: application/x-www-form-urlencoded
id
integer

Folder's ID.

name
string

folder's name

reference
string

folder's ID

status
string
Enum: "in progress" "completed"

folder's status

start_date
string

Folder's launch date (MM/YYYY)

end_date
string

Folder's closing date (MM/YYYY)

checksum
required
string

Request's validity checksum

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

delete folder

delete folder

Authorizations:
apikey
query Parameters
id
required
integer

Folder's ID.

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

highlight

management of questionnaires

Get custom questionnaires list

Retrieve custom questionnaires informations.

Authorizations:
apikey
query Parameters
company_id
integer

unique Immodvisor company ID

company_custom_id
string

Your unique company's identifier (can be used instead of company_id if it is filled in on Immodvisor).

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

activity

management of company activities

Get job's list

Get available professions' list

Authorizations:
apikey
query Parameters
checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

get job informations

Retrieve the activity's informations : username, lastname, list of possible services and list of associated Google My Business attributes.

Authorizations:
apikey
query Parameters
id
required
integer

activity id

checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

utils

endpoint utilities

check if api available

check if api available

Authorizations:
apikey
query Parameters
checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

get api's configurations

Retrieves the configuration associated to the API key.

Good to know : if the company_id corresponds to a brand (company.type='brand'), then the API key is valid on all companies (company.type='company') belonging to the brand. Moreover, some services are limited to brands.

Authorizations:
apikey
query Parameters
checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}

Get departments' list

Get the list of authorized departments on Immodvisor.

Authorizations:
apikey
query Parameters
checksum
required
string

Request's validity checksum

header Parameters
APIVERSION
required
string

API's Used version.

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "error": null,
  • "datas": {
    },
  • "checksum": "string"
}