Skip to main content
POST
Get Configuration Metadata

Authorizations

Authorization
string
header
required

User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as Authorization: Bearer <jwt>. The request resolves to the user's identity and is authorized by their Role on the {companyId} in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both BearerAuth and ApiKeyAuth.

Path Parameters

companyId
string<uuid>
required

Company identifier

Body

application/json

No input is required; the metadata is read from the database. An empty object is accepted.

Response

Configuration metadata returned successfully

Lightweight FMV1 configuration metadata for staleness checks — version identity and timestamps, WITHOUT the full configuration blob.

version
integer | null
required

The monotonic version of the latest stored configuration snapshot (starts at 1; a new snapshot is stored on every configuration import). null when no snapshot has been stored for the company yet. Pair it with contentHash to identify exactly which configuration state you observed.

Example:

7

contentHash
string | null
required

sha256 (lowercase hex) of the canonical serialized configuration for the latest stored snapshot. Content-stable — two equal hashes mean the configuration CONTENT is identical, so this is the token to use for compare-and-set workflows (re-importing identical content stores a new version but the SAME contentHash). null when no snapshot has been stored for the company yet. Every configuration write stores a new snapshot, so any configuration change is reflected here.

Example:

"5bdcf0bb62622f29da8ed6d7ed2c0300ff1b934f5b865874b4022541e102721f"

lastModifiedAt
string<date-time> | null
required

ISO 8601 timestamp of the last configuration change — the latest stored snapshot's creation time — or null when the company has no configuration yet.

Example:

"2026-06-25T18:32:10.114Z"

lastImportedAt
string<date-time> | null
required

ISO 8601 timestamp of the most recent onboarding configuration import, or null when the company has never imported a configuration.

Example:

"2026-06-20T09:15:00.000Z"