Skip to content

Get all product criteria
Leads
Properties
Customers
Websites

Request

Returns all product criteria definitions for the site, including type, label, activation state and personalisation flags. Requires SITE_CONFIG permission and RS:CRITERE_PRODUCT_ALL right.

Criteria types:

TypeDescriptionValue format
UNIQUESingle choice from predefined valuesvalue code string
NUMBERNumeric valueNumber (int or float)
FLAGBoolean0 or 1
TEXTFree textString
MULTIPLEMultiple choice from predefined valuesArray of value code strings
DATEDate/datetimeISO 8601 or dd/MM/yyyy

Use GET /criterias/product/{id}/values to get the valid values for UNIQUE/MULTIPLE type criteria.

Common criteria examples:

XML KeyTypeDescription
TypeBienUNIQUEProperty type (Appartement, Maison, Terrain...)
TypeTransactionUNIQUETransaction type (Vente, Location...)
NbPiecesNUMBERNumber of rooms
SurfaceNUMBERLiving area in m²
PrixNUMBERPrice
conso_energNUMBEREnergy consumption (kWh/m²/year)
ConsoEnerUNIQUEDPE letter (A-G, auto-calculated from conso_energ)
AdresseTEXTStreet address
CodePostalTEXTPostal code
VilleTEXTCity
AlentourTEXTGPS coordinates ("lat,lng")
Security
bearerAuth
curl -i -X GET \
  https://api-doc.immo-facile.com/_mock/openapi/criterias/product/all \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

List of product criteria

Bodyapplication/json
dataArray of objects(CriteriaResource)
Response
{
  "data": [
    { … }
  ]
}