# Retrieve renters by building id

Return all renters for a given building id

Endpoint: POST /api/tenant/{tenantId_path}/renter/getRentersByBuildingId
Version: v1

## Path parameters:

  - `tenantId_path` (string, required)

## Request fields (application/json-patch+json):

  - `buildingId` (string)

  - `datatable` (object)

  - `datatable.sort` (object,null)

  - `datatable.sort.sortBy` (integer)
    Enum: 1, 2, 3, 4, 5, 6, 7

  - `datatable.sort.sortMode` (integer)
    Enum: 1, 2

  - `datatable.pagination` (object)

  - `datatable.pagination.page` (integer)

  - `datatable.pagination.rowsPerPage` (integer)

  - `datatable.filters` (object,null)

  - `datatable.search` (object,null)

  - `datatable.search.value` (string)

## Response 200 fields (text/plain):

  - `list` (array)

  - `list.id` (string)

  - `list.state` (integer)
    Enum: 1, 2

  - `list.mediaUri` (string,null)

  - `list.reference` (string)

  - `list.label` (string)

  - `list.siret` (string,null)

  - `list.activeLeasesCount` (integer)

  - `list.activeLeasesTotalSurface` (number)

  - `list.isUnpaidAlertActivated` (boolean)

  - `list.buildingAccessesActivatedCount` (integer)

  - `list.isInternal` (boolean)

  - `datatable` (object)

  - `datatable.sort` (object,null)

  - `datatable.sort.sortBy` (integer)
    Enum: 1, 2, 3, 4, 5, 6, 7

  - `datatable.sort.sortMode` (integer)
    Enum: 1, 2

  - `datatable.pagination` (object)

  - `datatable.pagination.page` (integer)

  - `datatable.pagination.rowsPerPage` (integer)

  - `datatable.pagination.totalItems` (integer,null)

  - `datatable.filters` (object,null)

  - `datatable.filters.filterList` (array)

  - `datatable.filters.filterList.name` (integer)
    Enum: 1, 2, 3

  - `datatable.filters.filterList.values` (array)

  - `datatable.search` (object,null)

  - `datatable.search.value` (string)

  - `facets` (array)

  - `facets.facetInfos` (array)

  - `facets.facetInfos.count` (integer,null)

## Response 400 fields (text/plain):

  - `error` (string)