--- title: search.global | Doing Work API description: Search one shop for customers (name, email, phone), properties (address), equipment (kind, make, model, serial, notes), jobs (summary), requests (title). url: https://doingwork.work/docs/reference/search-global/ --- # search.global Search one shop for customers (name, email, phone), properties (address), equipment (kind, make, model, serial, notes), jobs (summary), requests (title), notes (words, on any record) and photos and videos (what the agent said they show, readable text such as serial numbers, video transcripts). Case-insensitive; you see only what your role can read. | | | |---|---| | Who | Agents can call this | | REST | `GET /v1/search` | | MCP tool | `search_global` | | Writes | no | | Area | [Imports, custom fields, tags and search](https://doingwork.work/docs/reference/#imports-custom-fields-tags-and-search) | ## When to use it Search one shop for customers (name, email, phone), properties (address), equipment (kind, make, model, serial, notes), jobs (summary), requests (title), notes (words, on any record) and photos and videos (what the agent said they show, readable text such as serial numbers, video transcripts). Case-insensitive; you see only what your role can read. ## What to tell the owner Tell them what you found in plain words. Don't read back raw fields. ## Input | Field | Type | Required | |---|---|---| | `shop_id` | string (uuid) | yes | | `q` | string | yes | | `limit` | integer | no | ## Example ```http GET https://doingwork.work/v1/search?shop_id=00000000-0000-4000-8000-000000000000&q=... ``` ## Output | Field | Type | Always there | |---|---|---| | `customers` | array | yes | | `customers[].customer_id` | string (uuid) | yes | | `customers[].name` | string | yes | | `customers[].email` | ['string', 'null'] | yes | | `customers[].phone` | ['string', 'null'] | yes | | `properties` | array | yes | | `properties[].property_id` | string (uuid) | yes | | `properties[].customer_id` | string (uuid) | yes | | `properties[].label` | ['string', 'null'] | yes | | `properties[].address_line1` | string | yes | | `equipment` | array | yes | | `equipment[].equipment_id` | string (uuid) | yes | | `equipment[].property_id` | string (uuid) | yes | | `equipment[].customer_id` | string (uuid) | yes | | `equipment[].kind` | string | yes | | `equipment[].make` | ['string', 'null'] | yes | | `equipment[].model` | ['string', 'null'] | yes | | `equipment[].serial` | ['string', 'null'] | yes | | `equipment[].notes` | ['string', 'null'] | yes | | `jobs` | array | yes | | `jobs[].job_id` | string (uuid) | yes | | `jobs[].customer_id` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `jobs[].status` | string | yes | | `jobs[].summary` | ['string', 'null'] | yes | | `requests` | array | yes | | `requests[].request_id` | string (uuid) | yes | | `requests[].customer_id` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `requests[].title` | string | yes | | `notes` | array | yes | | `notes[].note_id` | string (uuid) | yes | | `notes[].target_kind` | string | yes | | `notes[].target_id` | string (uuid) | yes | | `notes[].job_id` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `notes[].audience` | string | yes | | `notes[].snippet` | string | yes | | `notes[].created_at` | string (date-time) | yes | | `media` | array | yes | | `media[].media_id` | string (uuid) | yes | | `media[].job_id` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `media[].kind` | string | yes | | `media[].stage` | string | yes | | `media[].summary` | string | yes | ```json { "customers": [ { "customer_id": "00000000-0000-4000-8000-000000000000", "name": "Ruiz Plumbing", "email": "owner@example.com", "phone": "..." } ], "properties": [ { "property_id": "00000000-0000-4000-8000-000000000000", "customer_id": "00000000-0000-4000-8000-000000000000", "label": "...", "address_line1": "..." } ], "equipment": [ { "equipment_id": "00000000-0000-4000-8000-000000000000", "property_id": "00000000-0000-4000-8000-000000000000", "customer_id": "00000000-0000-4000-8000-000000000000", "kind": "...", "make": "...", "model": "...", "serial": "...", "notes": "..." } ], "jobs": [ { "job_id": "00000000-0000-4000-8000-000000000000", "customer_id": "00000000-0000-4000-8000-000000000000", "status": "...", "summary": "..." } ], "requests": [ { "request_id": "00000000-0000-4000-8000-000000000000", "customer_id": "00000000-0000-4000-8000-000000000000", "title": "..." } ], "notes": [ { "note_id": "00000000-0000-4000-8000-000000000000", "target_kind": "...", "target_id": "00000000-0000-4000-8000-000000000000", "job_id": "00000000-0000-4000-8000-000000000000", "audience": "...", "snippet": "...", "created_at": "..." } ], "media": [ { "media_id": "00000000-0000-4000-8000-000000000000", "job_id": "00000000-0000-4000-8000-000000000000", "kind": "...", "stage": "...", "summary": "..." } ] } ``` ## Errors | Code | Status | What to do | |---|---|---| | `invalid_input`, `invalid_token`, `rate_limited` | | Can happen on any call. See [errors](https://doingwork.work/docs/errors/). |