Lista kontaktfält

GET/api/v1/fields

Arbetsytans egna fält, även de som kommer från en nivå ovanför.

Behörighet

fields:read Läsa kontaktfält – personen bakom nyckeln måste vara alla medlemmar.

Svar

200 Alla fält i bruk.

dataarray<object>krävs
data[].keystringkrävs: Nyckeln i fields på en kontakt, och i kopplingsfält som {{attr.kundnummer}}.
data[].labelstringkrävs
data[].typestringkrävs: textnumberdatebooleanselectemailphoneurlpersonnummer
data[].optionsarray<string> | nullkrävs: Alternativen för ett fält av typen select.
data[].requiredbooleankrävs: Måste anges när en kontakt skapas.
data[].sensitivebooleankrävs: Känsligt fält (personnummer): kan varken läsas eller skrivas via API:t.
data[].inheritedbooleankrävs: Fältet kommer från en nivå ovanför i organisationen.

Fel

401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: insufficient_scope forbidden workspace_suspended
429: rate_limited
500: internal_error

Anrop

curl 'https://newsletter.qrona.se/api/v1/fields' \
  -H "Authorization: Bearer $QRONA_NEWSLETTER_KEY"

Svar 200

{
  "data": [
    {
      "key": "kundnummer",
      "label": "Kundnummer",
      "type": "text",
      "options": null,
      "required": false,
      "sensitive": false,
      "inherited": false
    }
  ]
}