Skip to Content
Uptimeify Docs

Benutzerdefinierte Felder auflisten

Gibt alle aktiven Definitionen für benutzerdefinierte Felder der Organisation zurück.

GET /api/custom-fields

Query Parameter

ParameterTypStandardBeschreibung
organizationIdnumberSession-OrgÜberschreibt den Organisations-Scope
envelopestringkeineritems: Antwort als { items, total, page, perPage }. Ab 18.01.2027 Standard.

Beispiel (cURL)

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

Antwort (Response)

{
  "items": [
    {
      "id": 1,
      "organizationId": 1,
      "name": "Data Center",
      "fieldKey": "data_center",
      "fieldType": "text",
      "isRequired": false,
      "displayOrder": 0,
      "options": [],
      "placeholder": "e.g. fsn1",
      "helpText": "Primary data center location",
      "showInTable": true,
      "isActive": true,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "perPage": 1
}

Listenform: Mit envelope=items kommt die Liste als { items, total, page, perPage }. Ohne den Parameter antwortet der Endpunkt noch in der bisherigen Form (ein blankes Array derselben Einträge); sie ist veraltet, ab dem 18.01.2027 ist { items, ... } der Standard.

Es werden nur aktive Felder (isActive: true) zurückgegeben, sortiert nach displayOrder.

Auf dieser Seite