Retrieve a Specific Userfield Category

Last modified on September 8, 2023 at 5:05 pm

Overview

Retrieves a specific userfield category with the specified id. The result of this GET request will be a JSON-encoded representation of a userfield category object. The object definition is provided below.

JSON Object Definition

The following is a full definition of all possible properties on the JSON object representing userfield categories. For a more detailed look at this object and its properties, see the Userfield Category Object Reference.

  1. {
  2.   "id": "",
  3.   "type": "",
  4.   "name": "",
  5.   "orderIndex": 0,
  6.   "createdDate": ""
  7. }

Examples

This example shows the retrieval of a public userfield category. Because it has an orderIndex value of 1, it appears as the second category in the set of public userfield categories.

Request
  1. GET /dc/api/v5/userfieldcategories/Biographical Information HTTP/1.1
  2. Host: api.digitalchalk.com
  3. Accept: application/json
Response
  1. HTTP/1.1 200 OK
  2. Content-type: application/json
  3. Content-length: 456 
  4.  
  5. {
  6.   "id": "Biographical Information",
  7.   "name": "Biographical Information",
  8.   "type": "public",
  9.   "orderIndex": 1,
  10.   "createdDate": "2009-07-03T23:20:17Z"
  11. }