fields.get

Custom field values on one record, with any required fields still empty. Money-type values and currency are null unless you may see prices (see_prices); key and type stay visible.

WhoAgents can call this
RESTGET /v1/fields/get
MCP toolfields_get
Writesno
AreaImports, custom fields, tags and search

When to use it

Custom field values on one record, with any required fields still empty. Money-type values and currency are null unless you may see prices (see_prices); key and type stay visible.

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
targetstring (one of customer, property, job, quote, invoice)yes
object_idstring (uuid)yes

Example

GET https://doingwork.work/v1/fields/get?shop_id=00000000-0000-4000-8000-000000000000&target=customer&object_id=00000000-0000-4000-8000-000000000000

Output

JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.

Errors

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