Versioning

The Planning Center API supports versioning on a per-application basis.

There are 2 ways to specify a version:

1. Setting a per-app default here
2. Passing a header on every request: X-PCO-API-Version with a value of YYYY-MM-DD

Versions are resolved in this order

• First: Request header specified version number
• Second: Per-App default version number

You can use both of these methods together. For example, you can set a per-app version, and if needed, override that with a header for any single request.

Version Matching

Version numbers are matched to a version using a equal-to-or-less-than algorithm.

For example: Given available versions of 2018-08-01, 2018-08-10, & 2018-08-17. Passing a version header of X-PCO-API-Version: 2018-08-14 will process the request using version 2018-08-10.

Using LATEST

If you want to be on the cutting edge (not recommended for production applications). You can pass X-PCO-API-Version: LATEST. Under the hood this is equivalent to always passing tomorrows date. Expect there to be breaking changes between versions.

Versions Prior to 2018-08-01

If you specify a version before the default version 2018-08-01 you will get a HTTP 400 status code and an error code of unsupported_version_error.