services.listDue

List service due dates for the shop, soonest first. Filter by customer, status (open by default, or done, cancelled, all) and due_before to see what is coming up.

WhoAgents can call this
RESTGET /v1/service-due
MCP toolservices_listDue
Writesno
AreaShop

When to use it

List service due dates for the shop, soonest first. Filter by customer, status (open by default, or done, cancelled, all) and due_before to see what is coming up.

What to tell the owner

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

Input

FieldTypeRequired
shop_idstring (uuid)yes
customer_idstring (uuid)no
statusstring (one of open, done, cancelled, all)no
due_beforestring (date)no
limitintegerno

Example

GET https://doingwork.work/v1/service-due?shop_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
itemsarrayyes
items[].service_due_idstring (uuid)yes
items[].shop_idstring (uuid)yes
items[].customer_idstring (uuid)yes
items[].customer_namestringyes
items[].job_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
items[].titlestringyes
items[].due_onstring (date)yes
items[].repeat_months['integer', 'null']yes
items[].statusstringyes
items[].reminded_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].closed_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].next_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
items[].created_atstring (date-time)yes
{
  "items": [
    {
      "service_due_id": "00000000-0000-4000-8000-000000000000",
      "shop_id": "00000000-0000-4000-8000-000000000000",
      "customer_id": "00000000-0000-4000-8000-000000000000",
      "customer_name": "...",
      "job_id": "00000000-0000-4000-8000-000000000000",
      "title": "...",
      "due_on": "...",
      "repeat_months": "...",
      "status": "...",
      "reminded_at": "...",
      "closed_at": "...",
      "next_id": "00000000-0000-4000-8000-000000000000",
      "created_at": "..."
    }
  ]
}

Errors

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