Private preview of the new site. Not live.

customers.get

One customer with contacts, properties, custom fields and open balance.

WhoAgents can call this
RESTGET /v1/customers/get
MCP toolcustomers_get
Writesno
AreaShop

When to use it

One customer with contacts, properties, custom fields and open balance.

What to tell the owner

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

Input

FieldTypeRequired
customer_idstring (uuid)yes

Example

GET https://doingwork.work/v1/customers/get?customer_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
customer_idstring (uuid)yes
shop_idstring (uuid)yes
kindstringyes
namestringyes
company_name['string', 'null']yes
email['string', 'null']yes
phone['string', 'null']yes
billing_address['object', 'null']yes
lead_source['string', 'null']yes
tagsarrayyes
notes['string', 'null']yes
archived_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
merged_into['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
erased_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
created_atstring (date-time)yes
updated_atstring (date-time)yes
contactsarrayyes
contacts[].contact_idstring (uuid)yes
contacts[].namestringyes
contacts[].email['string', 'null']yes
contacts[].phone['string', 'null']yes
contacts[].role['string', 'null']yes
contacts[].is_primarybooleanyes
propertiesarrayyes
properties[].property_idstring (uuid)yes
properties[].home_idstring (uuid)yes
properties[].label['string', 'null']yes
properties[].address_line1stringyes
properties[].address_line2['string', 'null']yes
properties[].localitystringyes
properties[].postal_codestringyes
properties[].jurisdiction_idstringyes
properties[].access_notes['string', 'null']yes
fieldsarrayyes
fields[].keystringyes
fields[].targetstringyes
fields[].typestringyes
fields[].valueyes
fields[].currency['string', 'null']yes
fields[].written_atstring (date-time)yes
open_balance_minorintegeryes
{
  "customer_id": "00000000-0000-4000-8000-000000000000",
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "kind": "...",
  "name": "Ruiz Plumbing",
  "company_name": "...",
  "email": "owner@example.com",
  "phone": "...",
  "billing_address": "...",
  "lead_source": "...",
  "tags": [
    "..."
  ],
  "notes": "...",
  "archived_at": "...",
  "merged_into": "00000000-0000-4000-8000-000000000000",
  "erased_at": "...",
  "created_at": "...",
  "updated_at": "...",
  "contacts": [
    {
      "contact_id": "00000000-0000-4000-8000-000000000000",
      "name": "Ruiz Plumbing",
      "email": "owner@example.com",
      "phone": "...",
      "role": "...",
      "is_primary": true
    }
  ],
  "properties": [
    {
      "property_id": "00000000-0000-4000-8000-000000000000",
      "home_id": "00000000-0000-4000-8000-000000000000",
      "label": "...",
      "address_line1": "...",
      "address_line2": "...",
      "locality": "Coeur d'Alene",
      "postal_code": "83814",
      "jurisdiction_id": "00000000-0000-4000-8000-000000000000",
      "access_notes": "..."
    }
  ],
  "fields": [
    {
      "key": "...",
      "target": "...",
      "type": "...",
      "value": "...",
      "currency": "...",
      "written_at": "..."
    }
  ],
  "open_balance_minor": 50000
}

Errors

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