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.
| |
|---|
| Who | Agents can call this |
| REST | GET /v1/sync/refs |
| MCP tool | sync_findRefs |
| Writes | no |
| Area | Shop |
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.
| Field | Type | Required |
|---|
shop_id | string (uuid) | yes |
system | string | yes |
kind | string (one of invoice, payment, refund, customer) | no |
external_id | string | no |
ids | array | no |
limit | integer | no |
cursor | string | no |
Example
GET https://doingwork.work/v1/sync/refs?shop_id=00000000-0000-4000-8000-000000000000&system=...
Output
| Field | Type | Always there |
|---|
data | array | yes |
data[].kind | string | yes |
data[].id | string (uuid) | yes |
data[].system | string | yes |
data[].external_id | string | yes |
data[].updated_at | string (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
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |