Contacts and Leads

Retrieve A List Of Contacts

Show list to contacts

get/v1/contacts

Request

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

Query parameters

cursorstring nullable

Cursor received in the previous request

contact_typeunknown
media_sourcestring nullable

Origin of the contact, such as website, name of an advertising portal

orderunknown
smart_listunknown
tagsstring nullable

Labels associated with the contact, such as owner, contact, lead, etc

clear_notificationsstring nullable
inactiveboolean nullable
manager_idstring nullable
search_textstring nullable
search_typestring nullable
string
OR
integer
search_date'created_at' | 'updated_at' nullable
start_datestring nullable
end_datestring nullable
filter_bystring nullable
review_pendingboolean nullable
birthdays_startstring date-time nullable
birthdays_endstring date-time nullable
show_mapboolean nullable
latstring nullable
lngstring nullable
radiusstring nullable

Response

Successful Response

countstring nullable
count_pedinginteger nullable
cursorstring nullable

Example response

{
  "contacts": [
    {
      "properties": [
        {
          "field_values": [
            {
              "field_id": "guarantor",
              "type": "boolean",
              "value": "True"
            },
            {
              "field_id": "bail",
              "type": "boolean",
              "value": "False"
            },
            {
              "field_id": "surety_bond",
              "type": "boolean",
              "value": "False"
            },
            {
              "field_id": "bond_application",
              "type": "boolean",
              "value": "True"
            },
            {
              "field_id": "credpago_guarantee",
              "type": "boolean",
              "value": "True"
            },
            {
              "field_id": "iptu",
              "type": "float",
              "value": "True"
            },
            {
              "field_id": "condominium",
              "type": "float",
              "value": "True"
            },
            {
              "field_id": "water",
              "type": "float",
              "value": "True"
            },
            {
              "field_id": "gas",
              "type": "float",
              "value": "True"
            },
            {
              "field_id": "light",
              "type": "float",
              "value": "True"
            },
            {
              "field_id": "cleaning_fee",
              "type": "float",
              "value": "True"
            },
            {
              "field_id": "value_to_fire_insurance",
              "type": "float",
              "value": "True"
            },
            {
              "field_id": "approx_fire_insurance_value",
              "type": "float",
              "value": "True"
            },
            {
              "field_id": "high_standard",
              "type": "boolean",
              "value": "True"
            },
            {
              "field_id": "with_plaque",
              "type": "boolean",
              "value": "True"
            },
            {
              "field_id": "exclusivity",
              "type": "boolean",
              "value": "False"
            },
            {
              "field_id": "private",
              "type": "boolean",
              "value": "False"
            }
          ]
        }
      ]
    }
  ]
}

Changes

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