Custom Fields

List Custom Fields

GET /api/custom-fields

get/api/custom-fields

Request

  • Base URL: https://uptimeify.io
  • URL: https://uptimeify.io/api/custom-fields
  • Auth: HTTP bearer

Query parameters

organizationIdstring

Global admins only; defaults to the own organization.

Response

Successful response

idinteger required
organizationIdinteger required
namestring required
fieldKeystring required

Key in customer.customFields; derived from name when not given.

fieldType'text' | 'number' | 'email' | 'url' | 'select' required
isRequiredboolean required
displayOrderinteger required
optionsstring[] nullable required

Choices of a select field.

placeholderstring nullable required
helpTextstring nullable required
showInTableboolean required
isActiveboolean required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.