Access to the GSL Leads API is currently limited. If you are interested in using this API, apply for access on that email address: support-laas@groupeseloger.com The GSL Leads API enables real estate agencies to find their leads in real-time. Real-time means that leads is receiving as soon as a user asked to be contacted by the real estate agency.

All the API endpoints use the OAuth 2.0 protocol. As soon as you get your personal client credentials from the customer support team, you will be allowed to generate an access token that will enable you to access all the features related to your usage plan.

This section lists the OAuth 2.0 scopes that you might need to request to access this API, depending on the level of access you need. Many scopes overlap, so it's best to use a scope that is as restrictive as possible. The access token issued will only contain the requested scopes.

note : scopes are case sensitive

The GSL Leads API is a RESTful API. The API allows you to interact with resources using verbs: POST, PUT, DELETE or GET.

• All the resources names are defined in plural. For instance: "GET /leads".
• The supported format is JSON.
• The fields are defined in camelCase.
• The boolean fields start by a "is" or "has" prefix.

The GSL Leads API follows the OpenAPI specification.

The GS Leads API is constantly being worked on to add features, improvements and bugfixes. This means that you should expect changes to be introduced and documented. Whenever we make a significant change to an endpoint, we will increase the version number used in the path of the resource being requested. The current API version is 'v2' so all the API request must be performed with this version number in the endpoints. Example: POST /v2/leads

We consider the following cases as backward-compatible changes (minor releases):

• Adding new optional parameters
• Adding new endpoints
• Adding new fields to existing API responses
• Changing the order of fields in existing API responses

• 2xx for successful operations
• 3xx for redirections
• 4xx for client errors
• 5xx for server errors

The GSL Leads API follow's the error response format proposed in RFC 7807 also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response. However, some error cases needs to be accompanied by a human readable documentation. Especially regarding any errors that might be encountered during the API format validation steps (400 Bad Request) in order to give sufficient information needed by API consumers to fix the parameters and/or the request body. This 400 Bad Request is detailed in the section below.

In addition to the information proposed in RFC 7807, we support "errors" and "errorSource" fields to convey the fine-grained details of the API format validation problems.

Example: [{"name": "EndDate", "reason": "Missing required parameter 'endDate'."}]

Example

{
  "errors": [
    {
      "title": "EndDate",
      "message": "Missing required parameter 'endDate'."
    }
  ]
}

First version of the API supporting GSL Leads v2.0.0