Retrieve a contact

Retrieve a contact belonging to your workspace.

GET/v1/leads/{lead_id}

Requires the leads:read scope

On this page

Example request
Authorization
Path parameters
Response
Errors

Requires leads:read, which exposes personal contact details. Keep this permission on trusted server integrations, not on a public website. Unknown IDs and contacts from another workspace both return 404.

Example request

curl "https://api.vestta.app/v1/leads/1" \
  -H "X-Api-Key: $VESTTA_API_KEY"

Authorization

X-Api-Keystringheaderrequired
Your API key, AC_LIVE_<key_id>.<secret>. Authorization: ApiKey <key> is also accepted.

Path parameters

lead_idintegerrequired≥ 1

Response

200 Successful response.

Response fields

statusstring default: ok always ok
dataExternalLeadrequired
- idintegerrequired
  Numeric lead ID.
- namestring
- typestring
  demandante (looking for a property), propietario (owner), agencia-inmobiliaria, entidad-bancaria or proveedor-servicios.
- statusstring
  Pipeline status, e.g. new, searching_property, active_negotiation, closed or inactive.
- activeboolean
- sourcestring
  Where the lead came from, e.g. web, manual, or the source sent on ingestion.
- phone_number_1string
  Primary phone in E.164 format.
- phone_number_2string
- landline_phonestring
- personal_emailstring
- professional_emailstring
- preferred_languagestring
  es, gb, fr, ge or it.
- search_preferencesarray of objects
  Structured search requests without internal notes.
  request_idstring
  operationsarray of strings
  property_typesarray of strings
  locationsarray of objects
  apartamentoApartmentPreferences
  specsobject
  viewsarray of strings
  featuresarray of strings
  subtypesarray of strings
  size_maxinteger
  size_mininteger
  price_maxinteger
  price_mininteger
  price_rent_maxinteger
  price_rent_mininteger
  bedrooms_mininteger
  bathrooms_mininteger
  num_terraces_mininteger
  size_terraces_mininteger
  doble_bedrooms_mininteger
  suite_bathrooms_mininteger
  casaHousePreferences
  specsobject
  viewsarray of strings
  featuresarray of strings
  subtypesarray of strings
  size_maxinteger
  size_mininteger
  price_maxinteger
  price_mininteger
  price_rent_maxinteger
  price_rent_mininteger
  bedrooms_mininteger
  bathrooms_mininteger
  num_terraces_mininteger
  size_terraces_mininteger
  doble_bedrooms_mininteger
  suite_bathrooms_mininteger
  plot_size_mininteger
  porch_size_mininteger
  localLocalPreferences
  specsobject
  featuresarray of strings
  subtypesarray of strings
  size_maxinteger
  size_mininteger
  price_maxinteger
  price_mininteger
  price_rent_maxinteger
  price_rent_mininteger
  height_mininteger
  facade_meters_mininteger
  showcase_meters_mininteger
  bathrooms_mininteger
  naveNavePreferences
  specsobject
  featuresarray of strings
  subtypesarray of strings
  size_maxinteger
  size_mininteger
  price_maxinteger
  price_mininteger
  price_rent_maxinteger
  price_rent_mininteger
  height_mininteger
  facade_meters_mininteger
  showcase_meters_mininteger
  almacenajeStoragePreferences
  Preferencias para almacenes y trasteros independientes.
  featuresarray of strings
  subtypesarray of strings
  size_maxinteger
  size_mininteger
  price_maxinteger
  price_mininteger
  price_rent_maxinteger
  price_rent_mininteger
  oficinaOficinaPreferences
  specsobject
  featuresarray of strings
  subtypesarray of strings
  size_maxinteger
  size_mininteger
  price_maxinteger
  price_mininteger
  price_rent_maxinteger
  price_rent_mininteger
  offices_mininteger
  bathrooms_mininteger
  meeting_rooms_mininteger
  num_terraces_mininteger
  size_terraces_mininteger
  terrenoTerrenoPreferences
  viewsarray of strings
  featuresarray of strings
  subtypesarray of strings
  topographyarray of strings
  size_maxinteger
  size_mininteger
  price_maxinteger
  price_mininteger
  price_rent_maxinteger
  price_rent_mininteger
  size_built_mininteger
  aparcamientoAparcamientoPreferences
  featuresarray of strings
  subtypesarray of strings
  min_seatsinteger
  price_maxinteger
  price_mininteger
  price_rent_maxinteger
  price_rent_mininteger
  edificioBuildingPreferences
  specsobject
  featuresarray of strings
  size_maxinteger
  size_mininteger
  subtypesarray of strings
  price_maxinteger
  price_mininteger
  price_rent_maxinteger
  price_rent_mininteger
  num_floors_mininteger
  num_locales_mininteger
  usable_area_mininteger
  num_parkings_mininteger
  num_viviendas_mininteger
  titlestring
  colorstring
  urgencystring
  statusstring
- created_atstring
  ISO 8601 timestamp with UTC offset. Leads are ordered by this field, newest first.
- updated_atstring
  ISO 8601 timestamp with UTC offset.

Errors

Status	When
401 Unauthorized	The API key is missing, malformed, unknown, revoked or expired.
403 Forbidden	The API key lacks the required scope.
404 Not Found	The resource does not exist in this business.
409 Conflict	Duplicate contact or idempotency key reused with a different payload.
422 Unprocessable Content	A path parameter, query parameter or body field is invalid.
500 Internal Server Error	Unexpected server error while processing the request.

Error bodies and how to handle each case: Errors.