> ## 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.Data.Category

# <a id="SuperOffice_WebApi_Data_Category" /> Class Category

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

Carrier object for Category.

```csharp theme={null}
public class Category : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[Category](SuperOffice.WebApi.Data.Category.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get Category 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var category = agent.GetCategory( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_Category__ctor" /> Category()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public Category()
```

## Properties

### <a id="SuperOffice_WebApi_Data_Category_CategoryGroup" /> CategoryGroup

Enum of the group this category belongs to, static list of 5 groups
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public CategoryGroup? CategoryGroup { get; set; }
```

#### Property Value

[CategoryGroup](SuperOffice.WebApi.Data.CategoryGroup.md)?

#### See Also

[Category](SuperOffice.WebApi.Data.Category.md).[CategoryGroup\_String](SuperOffice.WebApi.Data.Category.md#SuperOffice_WebApi_Data_Category_CategoryGroup_String)

### <a id="SuperOffice_WebApi_Data_Category_CategoryGroup_String" /> CategoryGroup\_String

Enum of the group this category belongs to, static list of 5 groups
Raw string enum value.

```csharp theme={null}
[JsonProperty("CategoryGroup")]
public string CategoryGroup_String { get; set; }
```

#### Property Value

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

#### See Also

[Category](SuperOffice.WebApi.Data.Category.md).[CategoryGroup](SuperOffice.WebApi.Data.Category.md#SuperOffice_WebApi_Data_Category_CategoryGroup)

### <a id="SuperOffice_WebApi_Data_Category_Deleted" /> Deleted

True if the category is deleted

```csharp theme={null}
public virtual bool Deleted { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_Category_EnableLeadStatus" /> EnableLeadStatus

True if the category should enable lead status

```csharp theme={null}
public virtual bool EnableLeadStatus { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_Category_Id" /> Id

The category identifier

```csharp theme={null}
public virtual int Id { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_Category_Rank" /> Rank

The rank of the category

```csharp theme={null}
public virtual short Rank { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_Category_Tooltip" /> Tooltip

The category description

```csharp theme={null}
public virtual string Tooltip { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_Category_Value" /> Value

The category name

```csharp theme={null}
public virtual string Value { get; set; }
```

#### Property Value

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

## See Also

[ListAgent](SuperOffice.WebApi.Agents.ListAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.CategoryGroup](/en/api/reference/webapi/SuperOffice.WebApi.Data.CategoryGroup.md)
- [SuperOffice.WebApi.Data.CategoryGuess](/en/api/reference/webapi/SuperOffice.WebApi.Data.CategoryGuess.md)
- [SuperOffice.WebApi.Data.CategoryEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.CategoryEntity.md)
- [SuperOffice.WebApi.Data.TicketCategory](/en/api/reference/webapi/SuperOffice.WebApi.Data.TicketCategory.md)
- [SuperOffice.WebApi.Data.KbCategory](/en/api/reference/webapi/SuperOffice.WebApi.Data.KbCategory.md)
- [SuperOffice.WebApi.Data.ProductCategory](/en/api/reference/webapi/SuperOffice.WebApi.Data.ProductCategory.md)