List review cards

GET

/api/v1/cards

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

• Digize

Every NFC review card, the busiest first, with its taps, ratings, Google clicks and feedback over the last 90 days.

Needs the reviews:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

rows

required

Array<object>

object

id

required

string

code

required

string

label

required

string

assignee

required

Any of:

object

object

id

required

string

name

required

string

null

null

design

required

string

Allowed values: printed plain

format

required

string

Allowed values: card stand sticker

status

required

string

Allowed values: shipping active disabled

orderId

required

string

hostname

required

string

deliveredAt

required

Any of:

string

string format: date-time

null

null

disabledAt

required

Any of:

string

string format: date-time

null

null

taps

required

Over the last 90 days, like the rest.

number

lastTapAt

required

Any of:

string

string format: date-time

null

null

ratings

required

number

sentToGoogle

required

number

feedback

required

number

average

required

number | null

total

required

number

Example

{
  "rows": [
    {
      "design": "printed",
      "format": "card",
      "status": "shipping"
    }
  ]
}

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