Skip to main content
GET
/
v2
/
admin
/
tenants
/
disabled
List Disabled Tenants
curl --request GET \
  --url https://api.voxo.co/v2/admin/tenants/disabled \
  --header 'Authorization: Bearer <token>'
{
  "records": [
    {
      "id": 123,
      "name": "<string>",
      "timezoneId": 123,
      "tenantCode": "<string>",
      "externalBillingId": "<string>",
      "partnerId": 123,
      "conduitPrefix": "<string>",
      "disabled": 123,
      "brandId": "<string>",
      "brandVertical": "<string>",
      "salesforceDomain": "<string>",
      "salesforceCTITasks": "<string>",
      "globalQueueActions": 123,
      "resellerType": "<string>",
      "dateCreation": "<string>",
      "billingV2": 123,
      "isResellerAccount": 123
    }
  ],
  "page": 123,
  "maxPage": 123,
  "totalRecords": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

query
string

Search filter for tenant name or code

Maximum string length: 255
sortBy
string

Sort column

Maximum string length: 50
sortDirection
enum<string>

Sort direction

Available options:
asc,
desc
paginated
integer
default:1

1 = paginated response, 0 = full list

Required range: 0 <= x <= 1
page
number

Page number

recordsPerPage
number

Records per page

export
integer
default:0

1 = email a CSV of the full result set to the requester

Required range: 0 <= x <= 1

Response

200 - application/json

Paginated disabled tenant list

records
object[]
required
page
number
required
maxPage
number
required
totalRecords
number
required