Tenant Units

Manage tenant units, including listing all units, creating a new one, retrieving a specific unit, and getting the default tenant unit.

List Tenant Units

get

Query parameters

pageintegerOptional

default to 1 if not passing this query

Example: 1

pageSizeintegerOptional

default to 10 if not passing this query

Example: 10

tenantIdstringRequiredExample: {{tenantId}}

Header parameters

X-Api-KeystringOptional

the API Key

Example: {{apiKey}}

Responses

200Success

application/json

get/admin/api/v1/tenantUnits

HTTPcURLJavaScriptPython

GET /admin/api/v1/tenantUnits?tenantId=text HTTP/1.1
Host: api.workfx.ai
Accept: */*

200Success

{
  "tenantUnits": [
    {
      "id": "text",
      "tenantId": "text",
      "name": "text",
      "createdTime": "text",
      "updatedTime": "text",
      "status": "active",
      "parentId": "text",
      "level": 0,
      "default": true
    }
  ],
  "pagination": {
    "totalCount": 1,
    "currentPage": 1,
    "pageSize": 1,
    "totalPages": 1
  }
}

Create a Tenant Unit

post

Query parameters

createDefaultAgentbooleanOptionalExample: False

createDefaultDatasetbooleanOptionalExample: False

tenantIdstringRequiredExample: {{tenantId}}

Header parameters

X-Api-KeystringOptional

the API Key

Example: {{apiKey}}

Body

application/json

idstringOptional

namestringRequired

parentIdstringOptional

defaultbooleanOptional

Responses

200Success

application/json

idstringOptional

tenantIdstringOptional

namestringRequired

createdTimestringOptional

updatedTimestringOptional

statusstring · enumOptionalPossible values:

parentIdstringOptional

levelintegerOptionalDefault: 0

defaultbooleanOptional

post/admin/api/v1/tenantUnits

HTTPcURLJavaScriptPython

POST /admin/api/v1/tenantUnits?tenantId=text HTTP/1.1
Host: api.workfx.ai
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "name": "rdc-poc-unit-2",
  "status": "active",
  "default": "true",
  "level": "0"
}

200Success

{
  "id": "text",
  "tenantId": "text",
  "name": "text",
  "createdTime": "text",
  "updatedTime": "text",
  "status": "active",
  "parentId": "text",
  "level": 0,
  "default": true
}

Get a Tenant Unit

get

Path parameters

tenantUnitIdstringRequiredExample: {{tenantUnitId}}

Query parameters

tenantIdstringRequiredExample: {{tenantId}}

Header parameters

X-Api-KeystringOptional

the API Key

Example: {{apiKey}}

Responses

200Success

application/json

idstringOptional

tenantIdstringOptional

namestringRequired

createdTimestringOptional

updatedTimestringOptional

statusstring · enumOptionalPossible values:

parentIdstringOptional

levelintegerOptionalDefault: 0

defaultbooleanOptional

get/admin/api/v1/tenantUnits/{tenantUnitId}

HTTPcURLJavaScriptPython

GET /admin/api/v1/tenantUnits/{tenantUnitId}?tenantId=text HTTP/1.1
Host: api.workfx.ai
Accept: */*

200Success

{
  "id": "text",
  "tenantId": "text",
  "name": "text",
  "createdTime": "text",
  "updatedTime": "text",
  "status": "active",
  "parentId": "text",
  "level": 0,
  "default": true
}

Default tenant unit

get

Query parameters

tenantIdstringRequiredExample: {{tenantId}}

Header parameters

X-Api-KeystringOptional

the API Key

Example: {{apiKey}}

Responses

200Success

application/json

objectOptional

get/admin/api/v1/tenantUnits/default

HTTPcURLJavaScriptPython

GET /admin/api/v1/tenantUnits/default?tenantId=text HTTP/1.1
Host: api.workfx.ai
Accept: */*

200Success

{}