API Reference - Fields – Trackops Support Center

Fields are custom built data points that allow customers to capture unique and custom data.

Listing Fields

Returns a collection of field records, optionally filtered by the available request parameters.

GET /api/v1/fields

Available Request Parameters:

Name	Type	Required	Description
id	integer	no	ID of the field.
name	string	no	Name of the field.
field_type	integer	no	ID of the field type.
field_type_tag	string	no	Unique string reference for the field type.

Available Field Types

Field Type Name	Field Type Tag	Data Type	Description
Address	ADDRESS	json string	Address related properties
Country	COUNTRY	string	2-character ISO country code.
Date	DATE	date	ISO formated date
Date (Birthday)	BIRTHDAY	date	ISO formatted date
Email Address	EMAIL	string	Valid email address
Input (Long)	LONG	string	Multi-line string
Input (Short)	INPUT	string	Single line string
Money	CURRENCY	decimal	Numeric value
Multiple Choice (Checkbox)	CHECKBOX	json string	One or more valid choices
Multiple Choice (Dropdown)	SELECT	string	Valid choice
Multiple Choice (Radio)	RADIO	string	Valid choice
Name (First, Middle, Last)	NAME	json string	Name related properties
Number	NUMBER	decimal	Numeric value
Website (URL)	LINK	string	Valid website address
Yes or No	YESNO	boolean	1 or 0
Yes, No, or N/A	YESNONA	boolean	1, 0, or an empty string

Getting a Field

Returns a single case region record, based on the numeric ID.

GET /api/v1/fields/{field_id}

Formatting Field Values from API Endpoints

When retrieving field values from applicable API endpoints, custom field values will always be formatted as a string, boolean, or numeric value. If you would prefer to receive structured data on field types that support it, pass the expand_field_values parameter with a value of "1" to the query string and the result will include json objects or arrays where applicable.

Custom Field Reference

Please note, the IDs listed in these examples are for demonstration purposes. The ID's of your fields will change.

Field Type	Description	Example Value
Address	A physical address	{ "id": 1, "value": { "address_1": "2000 Blake St", "address_2": "STE 123", "city": "Denver", "state": "CO", "zip": "80202", "country": "US" } }
Country	A two character ISO country code	{ "id": 10, "value": "US" }
Date	An ISO-formatted date stamp. The system can auto-detect some common date formats, however it is recommended to convert your dates into ISO format for consistency.	{ "id": 20, "value": "2019-06-25" }
Input (Long Answer)	A multi-line string. Line breaks can be added by using \n characters.	{ "id": 30, "value": "Hello\n\n World." }
Input (Short Answer)	A single-line string.	{ "id": 40, "value": "Hello World." }
Money	A numeric value (without currency code).	{ "id": 50, "value": "150.00" }
Multiple Choice	An exact match from the available choices. Please review the available to choices for your multiple choice fields in order to properly validate the input before submitting the request.	{ "id": 60, "value": "Option 1" }
Multiple Choice (Checkboxes)	One or more matches from the available choices. Please review the available to choices for your multiple choice fields in order to properly validate the input before submitting the request.	{ "id": 65, "value": ["Choice A", "Choice B"] }
Name	A person's name. Only the last name is required.	{ "id": 70, "value": { "first_name": "John", "middle_name": "B", "last_name": "Doe" } }
Number	A numeric value. Whole numbers and decimals are allowed.	{ "id": 80, "value": "8" }
Section	A special field, used to provide a header or separator when displaying content on the screen. Read How to Create Custom Fields to see practical uses for section fields.	{ "id": 85, "value": "Contact Information" }
Website	A fully qualified domain name. All website addresses must begin with https:// to be considered valid.	{ "id": 90, "value": "https://trackops.com" }
Yes / No	A boolean value. Available choices are 1 or 0.	{ "id": 100, "value": "0" }
Yes / No / NA	A boolean value with empty fields. Available choices are 1, 0, or an empty string.	{ "id": 110, "value": "" }