API Lifecycle
Understand the lifecycle stages, how much notice you get before an endpoint is retired, and how to find deprecated endpoints your app is calling.
Overview
Every Procore REST API endpoint sits at a lifecycle stage that tells you how stable it is and how much notice you get before it goes away. This page covers what each stage means for an integration you have already built, how long you have to migrate, and how to find out whether any of it affects you.
Lifecycle Stages
An endpoint matures through Pilot, Beta, and General Availability, then retires through Deprecated and Sunset. Sunset is an exit from any stage — an endpoint does not have to reach General Availability before it is retired.
| Stage | Your calls | Minimum notice before sunset | What to do |
|---|---|---|---|
| Pilot | Work now, but can change without notice | 3 months | Build on it only if you can absorb that |
| Beta | Work, but the contract is still moving | 6 months | Build, and watch the changelog |
| General Availability | Work, and keep working | 1 year | Nothing |
| Deprecated | Still work, but nothing new is built on it | Already announced | Migrate before the sunset date |
| Sunset | Stop working | — | Nothing — the endpoint is gone |
The notice you get is set by the stage the endpoint was in when its deprecation was announced. A Beta endpoint deprecated before it reaches General Availability gets the Beta period, not the General Availability one. The one exception is accelerated deprecation, covered in Deprecation and Sunset.
Deprecation and Sunset
Deprecation is the announced window before an endpoint is removed.
Accelerated deprecation is rare. Procore may put an endpoint on an accelerated deprecation path only when both of these hold: the functionality is going away, for example because the Procore tool behind the endpoint no longer supports it, and usage data shows nobody calls the endpoint. That window can be as short as a few weeks, and you’re notified the same way as for any deprecation. A Pilot endpoint in that position may be removed with no sunset period at all.
Dates can also move later. If migration to a replacement is going slowly, Procore may extend them.
During the window, your calls keep working and Procore keeps deploying fixes, but no new development happens on the endpoint and new applications are denied access. Reference pages are marked Deprecated and changelog entries cover fixes only.
How you’re notified. Procore posts every deprecation on the API Changelog. If your app calls the endpoint, Integration Health also flags it. See Find Deprecated Endpoints You Use. Treat the API Changelog post as the signal to migrate: it names the replacement, or says the functionality is going away.
Find Deprecated Endpoints You Use
Use Integration Health. It is scoped to your app, so it answers the question that actually matters — are any of the endpoints I call deprecated — instead of listing everything Procore has ever deprecated.
Its Deprecated Endpoint Usage observation flags deprecated routes your app is actively calling. The API Call Activity Report then confirms which ones and how often, including the infrequent code paths that are easiest to miss — a deprecated call buried in a once-monthly export is exactly what this surfaces.
Check it as soon as a deprecation is announced, not after sunset. See Integration Health and API Call Activity Report.
If you would rather automate the check, Procore’s OpenAPI Specification annotates deprecated endpoints with deprecated: true, the announcement date in x-deprecated-at, and the removal date in x-sunset, all as YYYY-MM-DD. Download it from the REST API Reference.
Need Help?
Please reach out to [email protected] if you have any questions regarding the API lifecycle.