Contracts
ERP

Retrieve A List Of Contracts

Get contracts list

get/v1/contracts

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/contracts
  • Auth: API key in header X-Imobzi-Secret

Query parameters

cursorstring nullable
smart_listunknown
search_textstring nullable
search_typestring nullable
start_atstring nullable
end_atstring nullable
property_idstring nullable
contact_idstring nullable

Response

Successful Response

cursorstring required

Cursor for pagination

countinteger required

Total count of contracts found

Example response

{
  "contracts": [
    {
      "status": "active",
      "contacts": [
        {
          "type": "person if has CPF"
        }
      ],
      "source": "imobzi"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.