Skip to main content

​
Value Types

Public API v2 reads are self-describing. Attribute values are returned in a value envelope: 
{
  "value_type": "string",
  "value": "Sarah"
}
The value_type tells clients how to render, edit, filter, and validate the value.

​
Common value types

Value typeUsed for
string, long_text, rich_textText values
number, percent, currencyNumeric values
booleanTrue or false values
timestamp, date, timeDate and time values
email, phone_number, url, uuidFormatted scalar values
select, contact_stage, account_stage, opportunity_stageSelect options and stages
record_referenceReferences to other records
contact_email, contact_phone_number, address, account_domainCompound values

​
Reading values

Reads always include value_type and value. 
{
  "attributes": {
    "amount": {
      "value_type": "currency",
      "value": {
        "amount": 150000
      }
    }
  }
}

​
Writing values

Writes usually send raw values inside attributes. 
{
  "attributes": {
    "amount": 150000
  }
}
Some fields also accept envelope-shaped writes, but raw values are easier for most integrations.

​
Filtering values

Filtering depends on the value type. For example:
  • Text-like values use contains, starts_with, and ends_with.
  • Numeric and time values use gt, gte, lt, lte, and between.
  • References and select-like values commonly use eq, ne, in, and not_in.
Use GET /api/v2/_schema/{record_type} to discover field-level filterability and sortability.

​
Detailed guides