/api/v1/tenants/me

GET

/api/v1/tenants/me

curl --request GET \
  --url https://example.com/api/v1/tenants/me \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer

Responses

200

OK

object

id

string format: uuid

slug

string

displayName

string

isActive

boolean

isOverLimit

boolean

overLimitReasons

Array<string>

isSandbox

boolean

parentTenantName

string

nullable

plan

object

id

string format: uuid

name

string

displayName

string

priceMonthly

number format: double

nullable

maxUsers

integer format: int32

nullable

maxApiKeys

integer format: int32

nullable

apiRequestsPerDay

integer format: int32

nullable

dataRetentionDays

integer format: int32

nullable

features

Array<string>

effectiveLimits

object

maxUsers

integer format: int32

nullable

maxApiKeys

integer format: int32

nullable

company

object

id

string format: uuid

name

string

countryCode

string

nullable

object

id

string format: uuid

slug

string

displayName

string

isActive

boolean

isOverLimit

boolean

overLimitReasons

Array<string>

isSandbox

boolean

parentTenantName

string

nullable

plan

object

id

string format: uuid

name

string

displayName

string

priceMonthly

number format: double

nullable

maxUsers

integer format: int32

nullable

maxApiKeys

integer format: int32

nullable

apiRequestsPerDay

integer format: int32

nullable

dataRetentionDays

integer format: int32

nullable

features

Array<string>

effectiveLimits

object

maxUsers

integer format: int32

nullable

maxApiKeys

integer format: int32

nullable

company

object

id

string format: uuid

name

string

countryCode

string

nullable

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "slug": "example",
  "displayName": "example",
  "isActive": true,
  "isOverLimit": true,
  "overLimitReasons": [
    "example"
  ],
  "isSandbox": true,
  "parentTenantName": "example",
  "plan": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "displayName": "example",
    "priceMonthly": 1,
    "maxUsers": 1,
    "maxApiKeys": 1,
    "apiRequestsPerDay": 1,
    "dataRetentionDays": 1,
    "features": [
      "example"
    ]
  },
  "effectiveLimits": {
    "maxUsers": 1,
    "maxApiKeys": 1
  },
  "company": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "countryCode": "example"
  }
}

object

id

string format: uuid

slug

string

displayName

string

isActive

boolean

isOverLimit

boolean

overLimitReasons

Array<string>

isSandbox

boolean

parentTenantName

string

nullable

plan

object

id

string format: uuid

name

string

displayName

string

priceMonthly

number format: double

nullable

maxUsers

integer format: int32

nullable

maxApiKeys

integer format: int32

nullable

apiRequestsPerDay

integer format: int32

nullable

dataRetentionDays

integer format: int32

nullable

features

Array<string>

effectiveLimits

object

maxUsers

integer format: int32

nullable

maxApiKeys

integer format: int32

nullable

company

object

id

string format: uuid

name

string

countryCode

string

nullable

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "slug": "example",
  "displayName": "example",
  "isActive": true,
  "isOverLimit": true,
  "overLimitReasons": [
    "example"
  ],
  "isSandbox": true,
  "parentTenantName": "example",
  "plan": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "displayName": "example",
    "priceMonthly": 1,
    "maxUsers": 1,
    "maxApiKeys": 1,
    "apiRequestsPerDay": 1,
    "dataRetentionDays": 1,
    "features": [
      "example"
    ]
  },
  "effectiveLimits": {
    "maxUsers": 1,
    "maxApiKeys": 1
  },
  "company": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "countryCode": "example"
  }
}

401

Unauthorized

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}