Tenant

Detail

GET/api/v1/tenant

Returns the workspace (tenant) that owns the API token used for the request.

Every API token belongs to exactly one tenant, and every other endpoint acts on that tenant's data. Call this to confirm which workspace a token points at, or as a cheap check that a token is still valid before a larger run.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Responses

200

OK

  • requestIdstringrequired

    Unique ID for this request. Quote it when reporting a problem.

  • dataobjectrequired
    Child attributes
    • idstringrequired

      Tenant ID.

    • namestringrequired

      Workspace name.

    • companystringrequired

      Company name registered for the workspace.

    • statusstringrequired

      Current status of the workspace.

    • isDedicatedbooleanrequired

      true if the workspace runs on dedicated infrastructure rather than shared infrastructure.

    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
401

Unauthorized

  • messagestringrequired
404

Not Found

  • messagestringrequired
429

Too Many Requests

  • messagestringrequired