Standardizations

Harvest v3 introduces a number of naming and structural conventions to improve consistency and predictability across resources.

Format Conventions

• Date-time fields use ISO 8601 format in UTC (for example, 2024-12-15T03:55:00.000Z).
• Date-only fields are suffixed with _on (for example, start_on).
• Date-time fields are suffixed with _at (for example, start_at).

Resource Relationships

• All parent resource IDs are included in child resources.
• Child resource IDs are not included in parent resources, unless:
  • The nested object contains unique information specific to the parent, and
  • There is no separate endpoint to access or modify that child resource.

Attribute Naming

• All priority-related attributes are named sort_order.
• All resources (except demographic_questions and demographic_answer_options) include base attributes: created_at and updated_at.

These standardizations support easier onboarding, reduce ambiguity, and make the API more self-consistent across resources.