--- title: customers.list | Doing Work API description: Customers of a shop, newest first, filtered by tag, lead source or archived. A field worker sees only customers on a job they are assigned to. url: https://doingwork.work/docs/reference/customers-list/ --- # customers.list Customers of a shop, newest first, filtered by tag, lead source or archived. A field worker sees only customers on a job they are assigned to. | | | |---|---| | Who | Agents can call this | | REST | `GET /v1/customers` | | MCP tool | `customers_list` | | Writes | no | | Area | [Shop](https://doingwork.work/docs/reference/#shop) | ## When to use it Customers of a shop, newest first, filtered by tag, lead source or archived. A field worker sees only customers on a job they are assigned to. ## 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 | | `tag` | string | no | | `lead_source` | string | no | | `archived` | boolean | no | | `limit` | integer | no | | `cursor` | string | no | ## Example ```http GET https://doingwork.work/v1/customers?shop_id=00000000-0000-4000-8000-000000000000 ``` ## Output | Field | Type | Always there | |---|---|---| | `data` | array | yes | | `data[].customer_id` | string (uuid) | yes | | `data[].shop_id` | string (uuid) | yes | | `data[].kind` | string | yes | | `data[].name` | string | yes | | `data[].company_name` | ['string', 'null'] | yes | | `data[].email` | ['string', 'null'] | yes | | `data[].phone` | ['string', 'null'] | yes | | `data[].billing_address` | ['object', 'null'] | yes | | `data[].lead_source` | ['string', 'null'] | yes | | `data[].tags` | array | yes | | `data[].notes` | ['string', 'null'] | yes | | `data[].archived_at` | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes | | `data[].merged_into` | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes | | `data[].erased_at` | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes | | `data[].created_at` | string (date-time) | yes | | `data[].updated_at` | string (date-time) | yes | | `next_cursor` | ['string', 'null'] | yes | | `summary` | string | yes | | `display` | object | yes | | `display.kind` | string (one of table, cards, timeline, checklist, map, calendar, chart) | yes | | `display.title` | string | yes | | `display.columns` | array | no | | `display.columns[].key` | string | yes | | `display.columns[].label` | string | yes | | `display.fields` | array | no | | `display.fields[].key` | string | yes | | `display.fields[].label` | string | yes | ```json { "data": [ { "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": "..." } ], "next_cursor": "...", "summary": "...", "display": { "kind": "table", "title": "..." } } ``` ## Errors | Code | Status | What to do | |---|---|---| | `invalid_input`, `invalid_token`, `rate_limited` | | Can happen on any call. See [errors](https://doingwork.work/docs/errors/). |