ImportOS · Docs
API reference

GET /v1/extension/me

Who this key belongs to and what it may do

Who this key belongs to and what it may do

The tenant (name, plan, country, currency), the key scopes and the features available to the extension: market price (Pro/trial plans), underwriter, add to Desk. Requires scope read:pricing.

  • Authentication: header Authorization: Bearer rv_live_... (API keys and scopes)
  • Required scope: read:pricing
Descriptions of the operation, parameters and fields come from the OpenAPI specification (openapi.json).

Responses

200

Connection info.

application/json · Schema: ExtensionMe

FieldTypeRequiredDescription
tenantobjectyes
tenant.idstring (uuid)yes
tenant.slugstringyes
tenant.namestringyes
tenant.plan"trial" | "starter" | "pro" | "business"yes
tenant.countrystringyes
tenant.currencystringyes
tenant.locale"uk" | "pl" | "en"yes
keyobjectyes
key.namestringyes
key.scopesstring[]yes
featuresobjectyes
features.market_pricebooleanyesMarket price from the listings cache is available for this plan.
features.underwritebooleanyesThe key can call POST /v1/underwrite (scopes read:pricing + read:listings).
features.add_to_deskbooleanyesThe key can create vehicles and offers (scope write:deals).
tariffsobjectyes
tariffs.source"tenant" | "typical"yes"tenant": tenants.settings.tariffs are used by the API; "typical": demo defaults.

400

Invalid request parameters or body (code validation_error).

application/problem+json · Schema: Problem

401

Missing, malformed, unknown, revoked or expired API key (code unauthorized).

application/problem+json · Schema: Problem

403

The API key lacks the scope required by this endpoint (code insufficient_scope).

application/problem+json · Schema: Problem

429

Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.

application/problem+json · Schema: Problem

On this page