Skip to content

Mandates

Mandate register (registre des mandats) — search, count, and detail.

Search mandates
Mandates

Request

Searches mandates in the mandate register (registre des mandats) with cursor-based pagination. Results are ordered by mandat_id descending.

The mandate register must be enabled for the site (MODULE_REGISTRE_MANDATS) and the authenticated scope must include at least one agency, otherwise the request is rejected.

Use include to load additional related data.

Security
bearerAuth
Query
per_pageinteger, <= 200

Number of results per page. Maximum 200, default 50.

Default:50
Example:per_page=50
cursorstring

Cursor for pagination (from a previous response's meta.next_cursor).

includestring

Comma-separated list of additional relations to include.

Available values: amendments.

Example:include=amendments
statusstring

Filter by one or more mandate statuses (comma-separated).

Allowed values: cancel, reserved, original_sans_saisi, fax_receive, saisi, waiting, original_receive, ended.

Example:status=saisi,waiting
status_webboolean

Filter on the web publication status.

typestring

Mandate type (referential C124), e.g. exclusif, simple.

Example:type=exclusif
formstring

Mandate form (referential criterion 1914), e.g. Vente, Recherche, Location, Negociation, Gestion.

Example:form=Vente
card_idinteger

Professional card ID.

card_numberstring

Professional card number.

numberstring

Mandate number.

created_fromstring, (date)

Filter mandates created on or after this date (ISO 8601).

created_tostring, (date)

Filter mandates created on or before this date (ISO 8601).

agency_idinteger

Filter by agency (manufacturer) ID, within the authenticated scope.

user_idinteger

Filter by negotiator (agent) ID.

principal_idinteger

Filter by principal (mandant) ID.

product_typestring

Filter by product type.

product_modelstring

Filter by product model/reference.

product_idinteger

Filter by product ID.

profile_idinteger

Filter by profile ID.

curl -i -X GET \
  'https://api-doc.immo-facile.com/_mock/openapi/mandates?per_page=50&cursor=string&include=amendments&status=saisi%2Cwaiting&status_web=true&type=exclusif&form=Vente&card_id=0&card_number=string&number=string&created_from=2019-08-24&created_to=2019-08-24&agency_id=0&user_id=0&principal_id=0&product_type=string&product_model=string&product_id=0&profile_id=0' \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>'

Responses

Paginated list of mandates

Bodyapplication/json
dataArray of objects(MandateResource)
metaobject(CursorPaginationMeta)

Pagination metadata for cursor-based listings.

Response
{ "data": [ { … } ], "meta": { "per_page": 50, "next_cursor": "eyJpZCI6MTIzfQ==", "prev_cursor": "string" }, "links": { "next": "string", "prev": "string" } }