Custom Field Categories API (used with Custom Forms)

Owned by Matt Kepple
Last updated: Apr 13, 2022
1 min read

Introduction

  • Custom Field Categories is the name given to the fields within a Custom Form

  • Custom Forms are used in the front end to create

    • Beneficiaries

    • Cases

  • As of March 2022 the API only supports the creation of Cases using Custom Forms. (To create beneficiaries using the API, use the older method of Beneficiary Categories)

Types of field in a Custom Form:

Front end term

Back end term in CUSTOM FIELD CATEGORIES

Available in beneficiary Categories

Available in Custom Forms

Front end term

Back end term in CUSTOM FIELD CATEGORIES

Available in beneficiary Categories

Available in Custom Forms

Text field short

 

Yes

 

Number field

 

Yes

 

Date and time confined field

 

No

 

Time field

 

Yes

 

Attachment field

 

Yes

 

Select field (i.e. a list field)

 

Yes

 

Tickbox field

 

No

 

Section divider

 

Yes

 

Extending Table

 

Yes

 

Text field long

 

No

 

Types of field available that are

 

API documentation

Custom Field Categories (aka Custom form) (Not merged)

Desc: get all custom_field_categories with fields

Use this to obtain the fields that will be used to create a case.

url: /custom_field_categories

params: default params

response example: default response example (multiple records)