List customers

GET

/api/v1/commerce/customers

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

• Digize

Contacts who’ve ordered or were added as customers, the biggest spenders first, with their addresses, consent and notes.

Needs the commerce:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

rows

required

Array<object>

object

id

required

The CRM contact’s id.

string

firstName

required

string

lastName

required

string

name

required

string

email

required

string

phone

required

string

location

required

string

company

required

string | null

tags

required

Array<string>

emailMarketing

required

string

Allowed values: subscribed not_subscribed unsubscribed

smsMarketing

required

string

Allowed values: subscribed not_subscribed unsubscribed

orders

required

number

amountSpent

required

What they’ve paid, less refunds.

number

firstOrderAt

required

Any of:

string

string format: date-time

null

null

lastOrderAt

required

Any of:

string

string format: date-time

null

null

customerSince

required

string format: date-time

addresses

required

Array<object>

object

id

required

string

label

required

string

line1

required

string

line2

required

string | null

city

required

string

region

required

string

postalCode

required

string

country

required

string

isDefault

required

boolean

notes

required

Array<object>

object

id

required

string

body

required

string

author

required

string

createdAt

required

string format: date-time

total

required

number

Example

{
  "rows": [
    {
      "emailMarketing": "subscribed",
      "smsMarketing": "subscribed"
    }
  ]
}

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"
  }
}