workspace

Get Workspace

Get current user's workspace details including credits and member count.

get/api/v1/workspace

Response

Successful Response

idstring uuid required
namestring required
avatar_colorstring nullable
created_atstring date-time nullable
budget_authority'credits' | 'paid_balance' required

Which budget a metered run draws down.

Two members, because there are two budgets. Free usage and paid usage are the same balance on the same account, spent at the same prices and refused by the same check; what a workspace paid for that balance decides what its refusal offers next, not how the run is admitted. A third member for the free tier is what let the two drift — different prices, different exemptions, different per-run sizing — while both claimed to meter usage.

member_countinteger required
feature_togglesobject
workspace_type'standard' | 'discovery' required
on_free_planboolean
national_county_coverageboolean
manage_billing_availableboolean

Changes

Changed in 7 of the 30 revisions of this API.6315

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 499d0b94aa9423See the full diff
    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

  • 604ea84d0ff714See the full diff
    • ●

      added the new paid_balance enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      removed the discovery_allowance enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      added the required property to the response with the status

      response-required-property-added

  • b8fec14143f244See the full diff
    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added subschema #2 to the response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added