GET v1/categories/{categoryId}

Returns the details and available options for a particular category

Request Information

URI Parameters

Name	Description	Type	Additional information
categoryId	Id for the category you want to retrieve	integer	Required

Body Parameters

None.

Sample Request

https://api.servicereef.com/v1/categories/{categoryId}

Response Information

Resource Description

CategoryDetailModel

Name	Description	Type	Additional information
Options		Collection of CategoryOptionModel
CategoryId		integer
Name		string
Description		string
Types		Collection of CategoryType
NumOptions		integer

Try API

Try this endpoint by entering your credentials and using the API Explorer.

Try With API Explorer

Response Formats

application/json, text/json

Sample:

{
  "Options": [
    {
      "CategoryOptionId": 1,
      "Name": "sample string 2"
    },
    {
      "CategoryOptionId": 1,
      "Name": "sample string 2"
    }
  ],
  "CategoryId": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Types": [
    "Opportunities",
    "Maps",
    "Groups",
    "Tracks",
    "Users"
  ],
  "NumOptions": 4
}

Back GET v1/categories/{categoryId}