Data Formats & Field Types

Understanding the formats and types used across AgentSync APIs ensures consistent integrations and reliable data handling.

Request and Response Formats

All request bodies must be in JSON format, and the following request header must be included:

• Content-Type: application/json

API responses are compressed using gzip and will return one of the following content types:

• Content-Type: application/json — all endpoints (Contracting, Hierarchies, Identity, ProducerSync)

v2 Naming Conventions

The v2 surfaces follow consistent conventions:

• JSON fields are lowerCamelCase (assignmentStatusName)
• Query parameters are lower_snake_case (updated_since, page_token)
• Timestamps end in At and are RFC3339 UTC (updatedAt: "2026-06-01T14:22:00Z")
• Dates end in On or are named as dates, formatted yyyy-MM-dd (effectiveOn: "2026-01-15")
• Related resources are inlined as an ...Id plus a ...Name companion — no lookup round trips

Common Field Types

Date Formats

All dates are in ISO 8601 format with UTC timezone:

{
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T15:45:30Z"
}

Best Practices

• Validate inputs: Ensure requests conform to JSON schema expectations.
• Handle gzip compression: Configure clients to automatically decompress responses.
• Use UUIDs consistently: Treat UUIDs as immutable identifiers across systems.
• Normalize dates: Always store and process dates in UTC to avoid timezone drift.