Skip to main content
GET
Read an enquiry

Authorizations

Authorization
string
header
required

The agency's secret key, sent as Authorization: Bearer <key>. One key per agency.

Query Parameters

external_id
string
required

Your enquiry id.

Required string length: 1 - 128

Response

The enquiry's current state.

Where an enquiry stands now.

enquiry_id
string<uuid>
required

Signal's id for the enquiry.

external_id
string
required

Your enquiry id.

transaction_type
enum<string>
required

sale or letting.

Available options:
sale,
letting
status
enum<string>
required

not_started: recorded, nothing sent. greeted: greeting sent, no reply yet. in_conversation: they've replied and the questions are under way. qualified: questions answered. quiet: they stopped replying. opted_out: asked us to stop.

Available options:
not_started,
greeted,
in_conversation,
qualified,
quiet,
opted_out
updated_at
string<date-time>
required

When anything about it last changed.

contact_id
string<uuid> | null

Signal's id for the person.

contact_external_id
string | null

Your contact id, once we know it.

branch_code
string | null

Which of the agency's branches it belongs to.

property
PropertyRef · object | null

The property it's about.

reason
enum<string> | null

Why nothing was sent. no_phone: no usable phone number. not_mobile: the number is a landline. no_consent: contact_by_whatsapp was false. opted_out: they've asked us to stop. stale: received more than 24 hours ago. suppressed: suppress_conversation was set, or the number isn't on a dev key's allow-list. transaction_type_off: the agency hasn't switched Signal on for sales, or for lettings. whatsapp_not_connected: the agency's WhatsApp number isn't connected yet.

Available options:
no_phone,
not_mobile,
no_consent,
opted_out,
stale,
suppressed,
transaction_type_off,
whatsapp_not_connected
qualification
SaleQualification · object

A buyer's answers to Signal's qualifying questions. New-homes buyers use the same shape.

last_message_at
string<date-time> | null

When the last message was sent, by either side.

last_message_from
enum<string> | null

contact: the person. agency: the agency's side, including Signal's own messages.

Available options:
contact,
agency