homeowner.getRequest

Your request and every reply so far. Poll this. Each reply shows the shop's own lines, total, deposit and message, and whether it was sent by the shop or by the shop's assistant.

WhoAgents can call this
RESTGET /v1/homeowner/requests/get
MCP toolhomeowner_getRequest
Writesno
AreaShop

When to use it

Your request and every reply so far. Poll this.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
request_idstring (uuid)yes

Example

GET https://doingwork.work/v1/homeowner/requests/get?request_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
request_idstring (uuid)yes
statusstringyes
tradestringyes
trade_text['string', 'null']yes
finding_shopsbooleanyes
rankingstringyes
title['string', 'null']yes
details['string', 'null']yes
address['object', 'null']yes
photo_idsarrayyes
sent_to_shopsintegeryes
sent_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
deleted_after['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
guest_quotesarrayyes
guest_quotes[].guest_quote_idstring (uuid)yes
guest_quotes[].shop_namestringyes
guest_quotes[].on_doing_workbooleanyes
guest_quotes[].price['object', 'null']yes
guest_quotes[].price_low_minor['integer', 'null']yes
guest_quotes[].price_high_minor['integer', 'null']yes
guest_quotes[].created_atstring (date-time)yes
guest_quotes[].notestringyes
repliesarrayyes
replies[].reply_idstring (uuid)yes
replies[].shop_idstring (uuid)yes
replies[].shop_namestringyes
replies[].statusstringyes
replies[].sent_bystringyes
replies[].sent_by_agentbooleanyes
replies[].lines['array', 'null']yes
replies[].total_minor['integer', 'null']yes
replies[].deposit_minor['integer', 'null']yes
replies[].currencystringyes
replies[].visit_firstbooleanyes
replies[].message['object', 'null']yes
replies[].sent_atstring (date-time)yes
replies[].typical_reply_minutes['integer', 'null']no
booking['object', 'null']yes
next['string', 'null']yes
pledgestringyes
stripe_feestringyes
pricesstringyes
{
  "request_id": "00000000-0000-4000-8000-000000000000",
  "status": "...",
  "trade": "...",
  "trade_text": "...",
  "finding_shops": true,
  "ranking": "...",
  "title": "...",
  "details": "...",
  "address": "...",
  "photo_ids": [
    "00000000-0000-4000-8000-000000000000"
  ],
  "sent_to_shops": 1,
  "sent_at": "...",
  "deleted_after": "...",
  "guest_quotes": [
    {
      "guest_quote_id": "00000000-0000-4000-8000-000000000000",
      "shop_name": "...",
      "on_doing_work": true,
      "price": "...",
      "price_low_minor": "...",
      "price_high_minor": "...",
      "created_at": "...",
      "note": "..."
    }
  ],
  "replies": [
    {
      "reply_id": "00000000-0000-4000-8000-000000000000",
      "shop_id": "00000000-0000-4000-8000-000000000000",
      "shop_name": "...",
      "status": "...",
      "sent_by": "...",
      "sent_by_agent": true,
      "lines": "...",
      "total_minor": "...",
      "deposit_minor": "...",
      "currency": "...",
      "visit_first": true,
      "message": "...",
      "sent_at": "..."
    }
  ],
  "booking": "...",
  "next": "...",
  "pledge": "...",
  "stripe_fee": "...",
  "prices": "..."
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.