# Tenant Units

## GET /admin/api/v1/tenantUnits

> List Tenant Units

```json
{"openapi":"3.0.1","info":{"title":"TargetPilot-Admin-API","version":"1.0.0"},"servers":[{"url":"https://api.workfx.ai","description":"Wfx Dev Env V1"}],"security":[],"paths":{"/admin/api/v1/tenantUnits":{"get":{"summary":"List Tenant Units","deprecated":false,"description":"","tags":[],"parameters":[{"name":"page","in":"query","description":"default to 1 if not passing this query","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"default to 10 if not passing this query","schema":{"type":"integer"}},{"name":"tenantId","in":"query","description":"","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","description":"the API Key","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"tenantUnits":{"type":"array","items":{"$ref":"#/components/schemas/tenantUnit"}},"pagination":{"$ref":"#/components/schemas/paginationResponse"}},"required":["tenantUnits"]}}},"headers":{}}}}}},"components":{"schemas":{"tenantUnit":{"type":"object","properties":{"id":{"type":"string"},"tenantId":{"type":"string"},"name":{"type":"string"},"createdTime":{"type":"string"},"updatedTime":{"type":"string"},"status":{"type":"string","enum":["active","inactive"]},"parentId":{"type":"string"},"level":{"type":"integer","default":0},"default":{"type":"boolean"}},"required":["name"]},"paginationResponse":{"type":"object","properties":{"totalCount":{"type":"integer"},"currentPage":{"type":"integer"},"pageSize":{"type":"integer"},"totalPages":{"type":"integer"}},"required":["totalCount","totalPages","pageSize","currentPage"]}}}}
```

## POST /admin/api/v1/tenantUnits

> Create a Tenant Unit

```json
{"openapi":"3.0.1","info":{"title":"TargetPilot-Admin-API","version":"1.0.0"},"servers":[{"url":"https://api.workfx.ai","description":"Wfx Dev Env V1"}],"security":[],"paths":{"/admin/api/v1/tenantUnits":{"post":{"summary":"Create a Tenant Unit","deprecated":false,"description":"","tags":[],"parameters":[{"name":"createDefaultAgent","in":"query","description":"","required":false,"schema":{"type":"boolean"}},{"name":"createDefaultDataset","in":"query","description":"","required":false,"schema":{"type":"boolean"}},{"name":"tenantId","in":"query","description":"","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","description":"the API Key","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"parentId":{"type":"string"},"default":{"type":"boolean"}},"required":["name"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"tenantId":{"type":"string"},"name":{"type":"string"},"createdTime":{"type":"string"},"updatedTime":{"type":"string"},"status":{"type":"string","enum":["active","inactive"]},"parentId":{"type":"string"},"level":{"type":"integer","default":0},"default":{"type":"boolean"}},"required":["name"]}}},"headers":{}}}}}}}
```

## GET /admin/api/v1/tenantUnits/{tenantUnitId}

> Get a Tenant Unit

```json
{"openapi":"3.0.1","info":{"title":"TargetPilot-Admin-API","version":"1.0.0"},"servers":[{"url":"https://api.workfx.ai","description":"Wfx Dev Env V1"}],"security":[],"paths":{"/admin/api/v1/tenantUnits/{tenantUnitId}":{"get":{"summary":"Get a Tenant Unit","deprecated":false,"description":"","tags":[],"parameters":[{"name":"tenantUnitId","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"tenantId","in":"query","description":"","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","description":"the API Key","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenantUnit"}}},"headers":{}}}}}},"components":{"schemas":{"tenantUnit":{"type":"object","properties":{"id":{"type":"string"},"tenantId":{"type":"string"},"name":{"type":"string"},"createdTime":{"type":"string"},"updatedTime":{"type":"string"},"status":{"type":"string","enum":["active","inactive"]},"parentId":{"type":"string"},"level":{"type":"integer","default":0},"default":{"type":"boolean"}},"required":["name"]}}}}
```

## GET /admin/api/v1/tenantUnits/default

> Default tenant unit

```json
{"openapi":"3.0.1","info":{"title":"TargetPilot-Admin-API","version":"1.0.0"},"servers":[{"url":"https://api.workfx.ai","description":"Wfx Dev Env V1"}],"security":[],"paths":{"/admin/api/v1/tenantUnits/default":{"get":{"summary":"Default tenant unit","deprecated":false,"description":"","tags":[],"parameters":[{"name":"tenantId","in":"query","description":"","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","description":"the API Key","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}}}}}}
```