AccountService
Accounts

Retrieves the current account for the token accessing the API

Retrieves the current account for the token accessing the API. Useful to check if the credentials are valid.

get/v1/account

Response

OK

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "spec": {
    "workspaces": [
      {
        "metadata": {
          "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
          "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
        }
      }
    ]
  }
}

Changes

Changed in 8 of the 57 revisions of this API.59

    • removed the optional property info/globalApiKey from the response with the 200 status

      response-optional-property-removed

    • added the optional property info/globalApiKey to the response with the 200 status

      response-optional-property-added

    • removed the optional property info/globalApiKey from the response with the 200 status

      response-optional-property-removed

  • 1124dfb0429a21See the full diff
    • removed the optional property info/globalApiKey/allOf[APIKey]/info/workspacesPreview from the response with the 200 status

      response-optional-property-removed

    • removed the optional property info/globalApiKey/allOf[APIKey]/info/workspacesTotal from the response with the 200 status

      response-optional-property-removed

    • added the required property info/globalApiKey/allOf[APIKey]/state to the response with the 200 status

      response-required-property-added

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

    • added the optional property info/challengeToken to the response with the 200 status

      response-optional-property-added

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

    • added the optional property info/globalApiKey/allOf[APIKey]/info/createdBy/allOf[Profile]/metadata/createdAt to the response with the 200 status

      response-optional-property-added

    • added the optional property info/globalApiKey/allOf[APIKey]/metadata/createdAt to the response with the 200 status

      response-optional-property-added

    • added the optional property metadata/createdAt to the response with the 200 status

      response-optional-property-added

    • added the optional property spec/workspaces/items/info to the response with the 200 status

      response-optional-property-added

    • added the optional property spec/workspaces/items/metadata/createdAt to the response with the 200 status

      response-optional-property-added

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

    • added the new PROFILE_TYPE_UNSPECIFIED enum value to the info/globalApiKey/allOf[APIKey]/info/createdBy/allOf[Profile]/spec/type response property for the response status 200

      response-property-enum-value-added

    • added the optional property spec/workspaces/items/status to the response with the 200 status

      response-optional-property-added