List custom fields

GET

/api/v1/contact-fields

curl --request GET \
  --url https://digize.com/api/v1/contact-fields \
  --header 'x-api-key: <x-api-key>'

• Digize

The custom fields kept on each contact, in the order contacts show them. Contacts’ custom values use each field’s key.

Needs the crm:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

Array<object>

object

id

required

string

label

required

string

key

required

string

type

required

string

Allowed values: text long_text number money date dropdown multi_select checkbox phone email url

group

required

string

options

required

Array<string>

unit

required

string | null

required

required

boolean

showOnForms

required

boolean

createdAt

required

string format: date-time

Example

[
  {
    "type": "text"
  }
]

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}