Get Category Entity
Gets a CategoryEntity object.
NsApiSlow threshold: 5000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
The identifier of the CategoryEntity object
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 CategoryEntity. Services for the CategoryEntity Carrier is available from the List Agent.
Primary key
Name of the category
Enum of the group this category belongs to, static list of 5 groups
Unknown, Customer, PotentialCustomer, Partner, Lost, Other Tooltip of the category
Rank of the category
True if the category should enable lead status
Optional link to family, for grouping things like multiple kinds of customer category under family 'customer'
true if the category is deleted
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
Get Ticket Category EntityGet All Ticket Category EntityGet Ticket Category Entity HeadingsNSTicketCategoryEntityGet Ticket Entity