CorefinityCorefinityDocs
Open the Control PanelControl Panel
Essentials · 12 of 12

Versioning

How the API is versioned today and which parts you can rely on.

On this page

There is one version of the API and it has no version in its URLs. Paths start at https://manage.corefinity.com/api.

What stays the same

PartRule
Refusal reason codesA code keeps its meaning. code always equals reason
invalid and invalid_argumentsBoth mean a field that is missing or wrong; treat them alike
Scope namesread, write, exec, destructive

Writing a client that keeps working

DoBecause
Ignore fields you do not knowAnswers gain fields as features are added
Branch on reason, never on messageMessages are for people and can be reworded
Treat an unknown status or reason as not finished or refusedNew values can appear
Expect 404 feature_offA feature can be off for your company

Features that are off

An endpoint whose feature is not on for your company answers 404 with reason: feature_off. It is documented here only once the feature is available.

Was this helpful?
Open in ClaudeOpen in ChatGPT