sync.findRefs

List outside ids a shop has recorded for one system. Filter by kind, by the outside id (to find the Doing Work record for it), or by Doing Work ids.

WhoAgents can call this
RESTGET /v1/sync/refs
MCP toolsync_findRefs
Writesno
AreaShop

When to use it

List outside ids a shop has recorded for one system. Filter by kind, by the outside id (to find the Doing Work record for it), or by Doing Work ids.

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
systemstringyes
kindstring (one of invoice, payment, refund, customer)no
external_idstringno
idsarrayno
limitintegerno
cursorstringno

Example

GET https://doingwork.work/v1/sync/refs?shop_id=00000000-0000-4000-8000-000000000000&system=...

Output

FieldTypeAlways there
dataarrayyes
data[].kindstringyes
data[].idstring (uuid)yes
data[].systemstringyes
data[].external_idstringyes
data[].updated_atstring (date-time)yes
next_cursor['string', 'null']yes
{
  "data": [
    {
      "kind": "...",
      "id": "00000000-0000-4000-8000-000000000000",
      "system": "...",
      "external_id": "00000000-0000-4000-8000-000000000000",
      "updated_at": "..."
    }
  ],
  "next_cursor": "..."
}

Errors

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