List contact fields

GET/api/v1/fields

The workspace's custom fields, including those that come from a level above.

Scope

fields:read Read contact fields – the person behind the key must be all members.

Response

200 All fields in use.

dataarray<object>required
data[].keystringrequired: The key in fields on a contact, and in merge fields such as {{attr.kundnummer}}.
data[].labelstringrequired
data[].typestringrequired: textnumberdatebooleanselectemailphoneurlpersonnummer
data[].optionsarray<string> | nullrequired: The options for a field of type select.
data[].requiredbooleanrequired: Must be provided when a contact is created.
data[].sensitivebooleanrequired: Sensitive field (personal identity number): can be neither read nor written via the API.
data[].inheritedbooleanrequired: The field comes from a level above in the organisation.

Errors

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

Request

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

Response 200

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