Contatos

Obter por ID

get/v1/contact/{id}

Request

  • Base URL: https://api.helena.run/core
  • URL: https://api.helena.run/core/v1/contact/{id}
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

ID do contato

Query parameters

IncludeDetailsstring[]

Detalhes que devem ser incluídos na resposta.

Response

Success

idstring uuid
createdAtstring date-time
updatedAtstring date-time
companyIdstring uuid
namestring nullable
nameWhatsappstring nullable
nameInstagramstring nullable
nameMessengerstring nullable
phoneNumberstring nullable
phoneNumberFormattedstring nullable
emailstring nullable
instagramstring nullable
messengerIdstring nullable
annotationstring nullable
tagIdsstring[] nullable
tagNamesstring[] nullable
status'ACTIVE' | 'ARCHIVED' | 'BLOCKED'
origin'CREATED_BY_USER' | 'CREATED_FROM_HUB' | 'IMPORTED'
importedAtstring date-time nullable
customFieldsobject nullable
portfolioIdsstring[] nullable
portfolioNamesstring[] nullable
metadataobject nullable

Changes

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