Skip to main content

Configuration (config.v1)

Reports the instance's effective configuration — the settings an integration would otherwise have to hardcode or guess. Like meta.v1, it requires no authentication; unlike most of the API, it speaks only XML and accepts only GET.

GET ~/config.v1
<Configuration version="26.2.4.30" source="cbafd139d9">
	<Setting key="EffortTracking" value="True" />
	<Setting key="StoryTrackingLevel" value="Off" />
	<Setting key="DefectTrackingLevel" value="On" />
	<Setting key="MaximumAttachmentSize" value="4194304" />
	<Setting key="CapacityPlanning" value="Off" />
	<Setting key="Scorecard" value="True" />
	<Setting key="ScorecardSelectiveBreakdown" value="True" />
	<Setting key="Scorecard.Charts.Query.Timeout" value="120000" />
	<Setting key="TimeZoneId" value="Eastern Standard Time" />
	<Setting key="TimeZoneDisplayName" value="(UTC-05:00) Eastern Time (US &amp; Canada)" />
	<Setting key="TimeZoneName" value="Eastern Daylight Time" />
</Configuration>

The root element's version and source attributes identify the build the instance is running — the quickest way to answer "what version is this instance?" programmatically. (A local development build reports 0.0.0.0 and unknown, because dev assemblies are not version-stamped.)

The Settings​

KeyMeaning
EffortTrackingWhether effort (Actuals) tracking is enabled on the instance
StoryTrackingLevel / DefectTrackingLevelWhere effort detail is tracked for the type: at the workitem itself (On), at its child tasks and tests (Off), or both (Mix)
MaximumAttachmentSizeThe upload limit in bytes — the size behind an attachment upload's 413
CapacityPlanningThe instance's capacity-planning level
Scorecard, ScorecardSelectiveBreakdownWhether the scorecard features are visible
Scorecard.Charts.Query.TimeoutScorecard chart query timeout, in milliseconds
TimeZoneIdThe instance time zone (Windows time-zone ID)
TimeZoneDisplayNameIts display form, with UTC offset
TimeZoneNameThe name currently in effect — daylight or standard, depending on the date

Two of these answer questions this documentation repeatedly tells you not to hardcode:

  • MaximumAttachmentSize — discover the real upload limit instead of handling 413 blind.
  • The time-zone keys — local timestamps such as ChangeDate are in the instance's time zone; this is where you learn which one that is. (For filtering and incremental loads, still prefer the …UTC twins.)