Uptimeify Docs
Custom fields

Get Custom Field

Returns one active custom field definition of your organization, in the same shape as an entry of List Custom Fields.

GET /api/custom-fields/{id}

Access

Any member of the organization. Only definitions of your own organization that are active are returned; a deleted (inactive) field answers 404.

Example (cURL)

BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"

curl -X GET "$BASE_URL/api/custom-fields/7" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Response

200 OK

{
  "id": 7,
  "organizationId": 10,
  "name": "Contract number",
  "fieldKey": "contract_number",
  "fieldType": "text",
  "isRequired": false,
  "displayOrder": 1,
  "options": null,
  "placeholder": "e.g. C-2026-001",
  "helpText": null,
  "showInTable": true,
  "isActive": true,
  "createdAt": "2026-06-01T08:00:00.000Z",
  "updatedAt": "2026-06-01T08:00:00.000Z"
}

Common errors

  • 400 Bad Request (fieldIdRequired) when the id is not a positive number
  • 401 Unauthorized when you are not logged in
  • 404 Not Found (customFieldNotFound) when the field does not exist, is inactive or belongs to another organization

On this page