> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Agents.IApiAgent

# \<a id="SuperOffice\_WebApi\_Agents\_IApiAgent">\</a> Interface IApiAgent

Namespace: [SuperOffice.WebApi.Agents](SuperOffice.WebApi.Agents.md)\
Assembly: SuperOffice.WebApi.dll

Interface for API agents: API info, tenant status, Client library version

```csharp theme={null}
public interface IApiAgent : IAgentBase, IDisposable
```

#### Implements

[IAgentBase](SuperOffice.WebApi.Agents.IAgentBase.md),
[IDisposable](https://learn.microsoft.com/dotnet/api/system.idisposable)

## Methods

### \<a id="SuperOffice\_WebApi\_Agents\_IApiAgent\_GetApiVersionAsync\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetApiVersionAsync(RequestOptions)

Gets version info from base URL.

```csharp theme={null}
Task<StringDictionary> GetApiVersionAsync(RequestOptions requestOptions = null)
```

#### Parameters

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[StringDictionary](SuperOffice.WebApi.Data.StringDictionary.md)\&gt;

Dictionary containing meta-data: "NetServerVersion", "Services", "Version"

### \<a id="SuperOffice\_WebApi\_Agents\_IApiAgent\_GetTenantStatusAsync\_System\_String\_System\_String\_SuperOffice\_WebApi\_RequestOptions\_">\</a> GetTenantStatusAsync(string, string, RequestOptions)

Returns the tenant status for a given customer, in a given environment.
Does not need base URL to be set.

```csharp theme={null}
Task<TenantStatus> GetTenantStatusAsync(string tenantCustId, string subdomain, RequestOptions requestOptions = null)
```

#### Parameters

`tenantCustId` [string](https://learn.microsoft.com/dotnet/api/system.string)

The Online customer id: "Cust1234"

`subdomain` [string](https://learn.microsoft.com/dotnet/api/system.string)

"sod", "qastage" or "online". Default "online" (production). See \<xref href="SuperOffice.WebApi.SubDomain" data-throw-if-not-resolved="false">\</xref>

`requestOptions` [RequestOptions](SuperOffice.WebApi.RequestOptions.md)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[TenantStatus](SuperOffice.WebApi.Data.TenantStatus.md)\&gt;

Tenant status


## Related topics

- [SuperOffice.WebApi.Agents.ApiAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ApiAgent.md)
- [SuperOffice.WebApi.Agents.IEMailAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IEMailAgent.md)
- [SuperOffice.WebApi.Agents.EMailAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.EMailAgent.md)
- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)
- [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)
- [SuperOffice.WebApi.Agents.AIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AIAgent.md)