Private preview of the new site. Not live.

shops.transfers

Hand-offs of a shop, newest first. The owner sees all of them; a worker sees only the ones naming them. Without shop_id: every hand-off naming you.

WhoAgents can call this
RESTGET /v1/shops/transfers
MCP toolshops_transfers
Writesno
AreaShop

When to use it

Hand-offs of a shop, newest first. The owner sees all of them; a worker sees only the ones naming them.

What to tell the owner

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

Input

FieldTypeRequired
shop_idstring (uuid)no

Example

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

Output

FieldTypeAlways there
transfersarrayyes
transfers[].transfer_idstring (uuid)yes
transfers[].shop_idstring (uuid)yes
transfers[].shopstringyes
transfers[].from_person_idstring (uuid)yes
transfers[].from_name['string', 'null']yes
transfers[].to_person_idstring (uuid)yes
transfers[].to_name['string', 'null']yes
transfers[].statusstringyes
transfers[].old_owner_stays_as_officebooleanyes
transfers[].started_atstring (date-time)yes
transfers[].expires_atstring (date-time)yes
transfers[].completed_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
transfers[].cancelled_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
transfers[].processor_reverify_statusstringyes
transfers[].you_arestringyes
{
  "transfers": [
    {
      "transfer_id": "00000000-0000-4000-8000-000000000000",
      "shop_id": "00000000-0000-4000-8000-000000000000",
      "shop": "...",
      "from_person_id": "00000000-0000-4000-8000-000000000000",
      "from_name": "...",
      "to_person_id": "00000000-0000-4000-8000-000000000000",
      "to_name": "...",
      "status": "...",
      "old_owner_stays_as_office": true,
      "started_at": "...",
      "expires_at": "...",
      "completed_at": "...",
      "cancelled_at": "...",
      "processor_reverify_status": "...",
      "you_are": "..."
    }
  ]
}

Errors

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