Skip to content

Bazimo API (v1)

Languages
Servers
https://doc-api.bazimo.fr/

Authentications

Operations

Building

Operations

Expense

Operations

Invoice

Operations

Lease

Operations

LegalOwner

Operations

Lot

Operations

RealEstateCompany

Operations

Receipt

Operations

Renter

Operations

Supplier

Operations

User

Operations

Retrieve user by email

Request

Return user details by email

Path
tenantId_pathstringrequired
Body
emailstring
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/user/GetUserByEmail' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "email": "string"
  }'

Responses

OK

Body
userobject
Response
No response example

Retrieve users for select by building ID

Request

Return users for select by building ID

Path
tenantId_pathstringrequired
Body
buildingIdstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/user/GetUsersForSelectByBuildingId' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7"
  }'

Responses

OK

Body
listArray of objects
Response
No response example

Retrieve users by building ID

Request

Return all users of a building id

Path
tenantId_pathstringrequired
Body
buildingIdstring(uuid)
datatableobject
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/user/GetUsersByBuildingId' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
    "datatable": {
      "sort": {
        "sortBy": 1,
        "sortMode": 1
      },
      "pagination": {
        "page": 0,
        "rowsPerPage": 0
      },
      "filters": {},
      "search": {
        "value": "string"
      }
    }
  }'

Responses

OK

Body
listArray of objects
datatableobject
facetsArray of objects
Response
No response example

Retrieve users by renter ID

Request

Return all users of a renter id

Path
tenantId_pathstringrequired
Body
renterIdstring(uuid)
datatableobject
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/user/GetUsersByRenterId' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "renterId": "5e8fd3a6-1229-4fc6-80e4-337191896d0b",
    "datatable": {
      "sort": {
        "sortBy": 0,
        "sortMode": 1
      },
      "pagination": {
        "page": 0,
        "rowsPerPage": 0
      },
      "filters": {},
      "search": {
        "value": "string"
      }
    }
  }'

Responses

OK

Body
listArray of objects
datatableobject
facetsArray of objects
Response
No response example

Retrieve responsibles by client ID

Request

Return all responsibles of a client id

Path
tenantId_pathstringrequired
Body
clientIdstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/user/GetResponsiblesByClientId' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"
  }'

Responses

OK

Body
listArray of objects
Response
No response example