Retrieve collection of serviceCategories

get

/services/rest/connect/v1.4/serviceCategories

Request

Supported Media Types
Query Parameters
  • Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name
  • The requested page size, which limits the number of elements the collection should max return
  • The offset of the page. By default, offset is 0, which means first page will be returned.
  • Returns the count of elements as the given order. The value is a comma delimited string. Each token in the string is the name of the field, optionally followed by asc or desc.
  • Query parameter that allows searching by providing ROQL WHERE clause filtering
  • Indicates whether or not to calculate the totalResults property. By default, totalResults is not calculated.

Response

Supported Media Types

Default Response

Body ()
Collection of serviceCategories
Root Schema : serviceCategories-collection
Type: object
Collection of serviceCategories
Show Source

Examples

Use GET with the following syntax to list all service categories:

https://your_site_interface/services/rest/connect/version/serviceCategories

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/serviceCategories

Response body example

{
  "items": [
    {
      "id": 29,
      "lookupName": "General",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/29"
        }
      ]
    },
    {
      "id": 30,
      "lookupName": "Information",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/30"
        }
      ]
    },
    {
      "id": 31,
      "lookupName": "Help",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/31"
        }
      ]
    },
    {
      "id": 32,
      "lookupName": "Account and Billing",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/32"
        }
      ]
    },
    {
      "id": 33,
      "lookupName": "Long Distance",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/33"
        }
      ]
    },
    {
      "id": 34,
      "lookupName": "Troubleshooting",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/34"
        }
      ]
    },
    {
      "id": 35,
      "lookupName": "Call Quality",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/35"
        }
      ]
    },
    {
      "id": 36,
      "lookupName": "Dial Tone",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/36"
        }
      ]
    },
    {
      "id": 37,
      "lookupName": "Disconnected",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/37"
        }
      ]
    },
    {
      "id": 41,
      "lookupName": "Renewals",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/41"
        }
      ]
    },
    {
      "id": 42,
      "lookupName": "Service Request",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/42"
        }
      ]
    },
    {
      "id": 43,
      "lookupName": "Hardware",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/43"
        }
      ]
    },
    {
      "id": 44,
      "lookupName": "Software",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/44"
        }
      ]
    },
    {
      "id": 45,
      "lookupName": "Voice Messaging",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories/45"
        }
      ]
    }
  ],
  "hasMore": false,
  "links": [
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/serviceCategories",
      "mediaType": "application/schema+json"
    },
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/serviceCategories"
    }
  ]
}