v1Resources/Custom Fields/getGet an entity's custom field values

Get an entity's custom field values

Returns the custom-field values stored on one location or client, keyed by field key.

get/api/v1/custom-fields/values

custom-fields:read

Query parameters

entityTypestring (location | client)required

The entity's type: "location" or "client".

entityIdstringrequired

ID of the location or client to read values for.

Response

dataobjectoptional

valuesobjectoptional

The entity's custom field values, keyed by field key. A value is a string, a number, an array of strings (for multi_select), or absent when unset.

Errors

400The request is missing a required parameter or is otherwise malformed.

401Missing, invalid, expired, or revoked API key.

403The key lacks the required scope, or isn't authorized for this client/location.

404The resource wasn't found, or doesn't belong to your agency.

429Too many requests. Retry after the number of seconds in the Retry-After header.

get/api/v1/custom-fields/values

Your API key

entityType *

entityId *

{
  "data": {
    "values": {
      "parking_notes": "Free lot behind the building."
    }
  }
}