# Get a mandate

Returns detailed information about a single mandate.
Use `include` to load additional related data.

Endpoint: GET /mandates/{mandateId}
Version: 1.6.0
Security: bearerAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer opaque

## Path parameters:

  - `mandateId` (integer, required)
    Unique identifier of the mandate.

## Query parameters:

  - `include` (string)
    Comma-separated list of additional relations to include.
**Available values:** `amendments`.

## Response 200:

  - `200` (unknown)
    Mandate details

## Response 200 fields (application/json):

  - `data` (object)
    A mandate entry from the mandate register.

  - `data.id` (integer)
    Mandate ID.
    Example: 12345

  - `data.order_number` (integer | null)
    Sequential order number of the mandate.

  - `data.number` (string | null)
    Mandate number.

  - `data.created_at` (string | null)
    Creation date.

  - `data.start_date` (string | null)
    Start date of the mandate.

  - `data.limit_date` (string | null)
    Deadline date (date butoir).

  - `data.term_date` (string | null)
    Term/expiry date (date échéance).

  - `data.sign_place` (string | null)
    Place of signature.

  - `data.form` (string | null)
    Mandate form (Vente, Recherche, Location, Negociation, Gestion).

  - `data.type` (string | null)
    Mandate type (exclusif, simple).

  - `data.status` (string | null)
    Mandate status.

  - `data.agency` (object)
    Agency the mandate belongs to.

  - `data.agency.id` (integer | null)

  - `data.agency.name` (string | null)

  - `data.card` (object)
    Professional card.

  - `data.card.id` (integer | null)

  - `data.card.number` (string | null)

  - `data.principal` (object)
    Principal (mandant).

  - `data.principal.id` (integer | null)

  - `data.principal.gender` (string | null)

  - `data.principal.first_name` (string | null)

  - `data.principal.last_name` (string | null)

  - `data.principal.location` (object)

  - `data.principal.location.address` (string | null)

  - `data.principal.location.zip_code` (string | null)

  - `data.principal.location.city` (string | null)

  - `data.principal.phone` (string | null)

  - `data.principal.email` (string | null)

  - `data.customers_associate` (integer | null)
    ID of the associated customer, if any.

  - `data.product` (object)
    Property attached to the mandate.

  - `data.product.id` (integer | null)

  - `data.product.model` (string | null)

  - `data.product.type` (string | null)

  - `data.product.price` (number | null)

  - `data.product.description` (string | null)

  - `data.product.area` (number | null)

  - `data.product.fees` (number | null)
    Total fees (honoraires).

  - `data.product.seller_fees` (number | null)
    Seller fees (honoraires vendeur).

  - `data.product.buyer_fees` (number | null)
    Buyer fees (honoraires acquéreur).

  - `data.original_products_id` (integer | null)
    ID of the original product, if the mandate was transferred.

  - `data.comment` (string | null)

  - `data.user` (object)
    Negotiator (agent) in charge.

  - `data.user.id` (integer | null)

  - `data.user.name` (string | null)

  - `data.amendment_of` (integer | null)
    ID of the parent mandate when this entry is an amendment.

  - `data.is_amendment` (boolean)
    Whether this mandate is an amendment (avenant).

  - `data.root_mandate` (object | null)
    Root mandate reference when applicable.

  - `data.amendments` (array | null)
    List of amendments. Loaded with `include=amendments`.

## Response 403:

  - `403` (unknown)
    Access denied. The error `code` is always `FORBIDDEN`; the `message` gives the cause:
- `You do not have permission to perform this action.`
 — the access does not

hold the API pack / right required by the endpoint.
- `Insufficient scope for this request.`
 — the resource targeted by the request

(user, customer, product, agency, transaction, ...) is outside the scope of

the authenticated access.
- `Access denied for this editor.`
 /
`Your IP address has been blocked.`
 —

editor or IP restriction.

## Response 403 fields (application/json):

  - `error` (object)

  - `error.code` (string, required)

  - `error.message` (string, required)

## Response 422:

  - `422` (unknown)
    Validation failed

## Response 422 fields (application/json):

  - `error` (object)

  - `error.code` (string)
    Enum: "VALIDATION_ERROR"

  - `error.message` (string)

  - `error.details` (array)

  - `error.details.field` (string)

  - `error.details.message` (string)

## Response 403 examples:

  - `Missing API pack / right` (unknown)

  - `Resource outside the scope of the access` (unknown)

