Thanks to visit codestin.com
Credit goes to developer.hyperproof.app

Skip to content
Hyperproof API
/
/
Custom Fields API

Custom Fields API (1.0)

Provides access to the custom fields that are part of a Hyperproof organization.

Download OpenAPI description
customfields.openapi.json
customfields.openapi.yaml
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/custom-fields/customfields.openapi
Hyperproof US
https://api.hyperproof.app/v1/customfields
Hyperproof Gov
https://api.hyperproofgov.app/v1/customfields
Hyperproof EU
https://api.hyperproof.eu/v1/customfields

Get Custom Fields

Request

GET /

Description

Retrieves a list of all custom fields defined within an organization, including their names, data types, and associated entities.

Security
oauth2
Query
objectTypestring(ObjectType)

Filters custom fields by the provided object type

Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/custom-fields/customfields.openapi/?objectType=audit' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
idstringrequired
Example: "d88d505d-5199-11ee-a644-522476618ae8"
orgIdstringrequired
Example: "ce83e3cd-5199-11ee-a644-522476618ae8"
namestringrequired
Example: "Location"
typestring(CustomFieldType)required
Enum"text""number""date""user""textSingleSelect""textMultiSelect"
behaviorstring(CustomFieldBehavior)
Enum"controlManaged""controlIndependent""controlAggregatedAverage""controlAggregatedMinimum""controlAggregatedMaximum""controlAggregatedSum"
availableOnArray of strings(ObjectTypeCollection)
Items Enum"audit""connection""control""controlScope""domain""freshnessHistory""exportFile""label""organization""organizationUser"
iconstring(Icon)required
Enum"calendar1""calendar2""person""people""location""horizontalBar""explodedDonut""explodedPie""clock""applicationServer"
isRequiredbooleanrequired
defaultTextValuestring
defaultDateValuestring
defaultNumberValuenumber(double)
optionsArray of objects(CustomFieldOptionCollection)required
options[].​idstring
options[].​orgIdstring
options[].​fieldIdstring
options[].​isDefaultboolean
options[].​textValuestring
numberFormatstringrequired
Enum"decimal""percentage"
statusstring(ObjectStatus)

The status of the object

Enum"active""archived"
createdBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
createdOnstring
Example: "2023-09-12T18:26:10.005365Z"
updatedBystring
Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
updatedOnstring
Example: "2023-09-12T18:26:10.005365Z"
permissionsArray of strings
Example: []
]
Response
application/json
[
  {
    "id": "d88d505d-5199-11ee-a644-522476618ae8",
    "orgId": "ce83e3cd-5199-11ee-a644-522476618ae8",
    "name": "Location",
    "type": "textSingleSelect",
    "availableOn": [ … ],
    "icon": "Location",
    "isRequired": false,
    "options": [ … ],
    "status": "active",
    "createdBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
    "createdOn": "2023-09-12T18:26:10.005365Z",
    "updatedBy": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
    "updatedOn": "2023-09-12T18:26:10.005365Z",
    "permissions": []
  }
]
® 2026 Hyperproof All Rights Reserved.