Versioning

Versioning

API versions are specified in the url. Older versions of the API will continued to be supported until it the usage is deemed too small to feasibly maintain, at which point remaining customers will be sent a 30 day (minimum) warning.

Our goal is to never break functionality on an existing API endpoint. When we make backwards-incompatible changes to the API or dataset, we'll create a new version. The most up to date version of the API is v5. The next version of the API will be v6. We perform batch data builds on a quarterly basis. We don't perform any streaming updates to the dataset between data releases. Each version of the API will use the most recent, up-to-date data release.

You can view our Example Record to better understand the person data schema, although each API endpoint will have its own unique response. Data releases happen every 3 months between the 1st and 15th of the first month of the fiscal quarter. After a data release, barring any significant update that breaks existing functionality in the API, the newly built data will be returned in existing versions of the API. Therefore, the dataset is not completely static; the number of fields/data points a specific profile has may increase/decrease through time.

In a single API version, we make persistence commitments in our Person Manual relating to certain fields.

Endpoints

All API endpoints follow the standard format /version/entity/product.

Version (explained above) is the version of our API endpoint, which will never have breaking functionality changes. Breaking changes (such as a new schema) will only occur when we convert to a new endpoint.

Entity is the type of data handled by the API. The core data model we focus on is person data. However, we also have company, location, and school data.

Product is a distinguishing tag since we have multiple endpoints for each entity. For example, we currently have an enrichment and a search endpoint for the person endpoint.


Did this page help you?