Resource URL


In order to create userfields for capturing user information, you must first create userfield categories in which to place the userfield. This will be reflected in the user interface as a category heading above the userfield prompt and entry areas, visually grouping together userfields which belong to the same category. A userfield can only be in one category.

There are two types of categories: public and private. These allow administrators to use one system to capture and manage user information, but only public categories are visible to the end user. Userfields placed into private categories are only visible to and modifiable by your organization’s administrators.

You can find details of the JSON representation of userfield categories by referring to the Userfield Category Object Reference.

Use Case Examples

GET requests

Operation Call Description
Retrieve all userfield category data GET /api/v5/userfieldcategories Retrieve all userfield category data.
Retrieve a specific userfield category GET /api/v5/userfieldcategories Retrieve all data about a specific userfield category identified by {id}.

POST requests

Operation Call Description
Create a new public userfield category POST /api/v5/userfieldcategories Create a new public userfield category for user-modifiable information
Create a new private userfield category POST /api/v5/userfieldcategories Create a new private userfield category for administrator-managed information

PUT requests

Operation Call Description
Update userfield category PUT /api/v5/userfieldcategories/{userfieldcategoryId} Modify basic userfield category properties

DELETE requests

Operation Call Description
Delete a userfield category DELETE /api/v5/userfieldcategories/{userfieldcategoryId} Remove a userfield category from the system