List custom fields

GET

/customer-fields

curl --request GET \
  --url https://api.usesonora.com/v1/customer-fields \
  --header 'Authorization: Bearer <token>'

The custom fields a customer’s customFields may carry: each key, its label and type, and a select field’s options.

Requires the customers:read scope.

Authorizations

• apiKey
• oauth
  customers:read

Responses

200

Every visible custom field.

Media typeapplication/json

object

data

required

Array<object>

A custom field on customers.

object

key

required

The key in a customer’s customFields.

string

label

required

string

type

required

date is YYYY-MM-DD; datetime an ISO 8601 instant; select one of options (or several, with multiple); user a list of people.

string

Allowed values: string number boolean date datetime select user array object

format

required

How the value is meant: currency, percentage, email, url, phone, … Null when it’s plain.

string | null

options

required

Any of:

Array<string>

Array<string>

null

null

multiple

required

Whether the value is a list: a multi-select, or a user field holding several people.

boolean

Example

{
  "data": [
    {
      "type": "string"
    }
  ]
}

401

unauthorized: The Authorization header is missing, or the key is invalid, revoked or expired.

Media typeapplication/json

The one error shape every endpoint answers with.

object

error

required

object

code

required

Stable snake_case code to branch on; see the error table.

string

message

required

For humans; may change.

string

details

object

key

additional properties

requestId

required

Quote it when asking for help.

string | null

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {
      "additionalProperty": "example"
    },
    "requestId": "example"
  }
}

403

insufficient_scope: The key or token lacks the scope this endpoint needs, and details.required names it; or an OAuth access token called an endpoint only an API key can.

Media typeapplication/json

The one error shape every endpoint answers with.

object

error

required

object

code

required

Stable snake_case code to branch on; see the error table.

string

message

required

For humans; may change.

string

details

object

key

additional properties

requestId

required

Quote it when asking for help.

string | null

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {
      "additionalProperty": "example"
    },
    "requestId": "example"
  }
}

429

rate_limited: Too many requests for this key; retry after Retry-After seconds.

Media typeapplication/json

The one error shape every endpoint answers with.

object

error

required

object

code

required

Stable snake_case code to branch on; see the error table.

string

message

required

For humans; may change.

string

details

object

key

additional properties

requestId

required

Quote it when asking for help.

string | null

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {
      "additionalProperty": "example"
    },
    "requestId": "example"
  }
}

500

internal_error: Something went wrong on Sonora’s side. Retry, and quote requestId if it persists.

Media typeapplication/json

The one error shape every endpoint answers with.

object

error

required

object

code

required

Stable snake_case code to branch on; see the error table.

string

message

required

For humans; may change.

string

details

object

key

additional properties

requestId

required

Quote it when asking for help.

string | null

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {
      "additionalProperty": "example"
    },
    "requestId": "example"
  }
}