Skip to main content
Get Category

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

categoryId
integer<int32>
required

The identifier of the Category object

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Response

OK

Carrier object for Category. Services for the Category Carrier is available from the List Agent.

Id
integer<int32>

The category identifier

Value
string

The category name

Tooltip
string

The category description

CategoryGroup
enum<string>

Enum of the group this category belongs to, static list of 5 groups

Available options:
Unknown,
Customer,
PotentialCustomer,
Partner,
Lost,
Other
EnableLeadStatus
boolean

True if the category should enable lead status

Rank
integer<int32>

The rank of the category

Deleted
boolean

True if the category is deleted

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.