Skip to navigation

Get Publish State

Whether this organization’s live terminology is up to date.

Reports when terminology was last published and by whom, when it was last edited, and a drift verdict comparing the two. Also carries the job for a publish or import in progress, if there is one.

Every kind of edit counts toward drift — terms, categories, custom fields, their ordering, variant settings, and deletions — so anything that changes what would be published marks the terminology out of date.

For an organization publishing more than one language, languages carries each one separately and drift summarises the worst of them, so it never reports up to date while one language is behind.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful Response
driftstring

in_sync (no change recorded since the last publish), out_of_sync (changed since the last publish), never_published, publishing (a publish is running, so the comparison is not meaningful yet), incomplete (published but the last build did not finish), or unknown (the live state is unavailable). in_sync reports that nothing was observed to change, which is not a guarantee that every edit reached the live copy — publish again if in doubt; doing so when already up to date is harmless.

languagestring

The language the top-level fields describe. Organizations with terminology in more than one language should read languages.

last_published_atdatetime or nullOptional
last_published_bystring or nullOptional
last_compiled_atdatetime or nullOptional
last_changed_atdatetime or nullOptional

When this organization’s terminology was last edited. Covers every change that affects what gets published — terms, categories, custom fields, ordering, variant settings and deletions. Null if nothing has been edited.

languageslist of objectsOptional

Publish state for every language this organization has terminology in. Terminology tagged as language-independent is published with each of them.

active_jobobject or nullOptional
Set while a publish or import is in progress.
errorstring or nullOptional

Set when the live state could not be read; drift is then unknown.

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error