Response Body

Format

All responses will be an object with fields data and metadata. data will be the resource while metadata will be any extra fields related to the resource. metadata will always include url and version.

Unpopulated arrays are always [], unpopulated objects are always {}, and all other unpopulated fields are null.

Responses follow a must ignore processing model, where clients are expected to ignore data fields they don't understand.

Dates and timestamps

All temporal fields in the API are encoded in ISO 8601 format and are by definition always treated as UTC. The most common time fields in the API are createdAt and updatedAt.

{
  "data": {
    "uid": "00000000-0000-0000-0000-000000000000",
    "firstName": "Brent",
    "lastName": "Roberts"
  },
  "metadata": {
    "url": "https://api.podium.com/v4/example",
    "version": "2021.04.01"
  }
}