Customers to ask for a review

GET

/api/v1/reviews/requests/candidates

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

• Digize

Customers with a paid order in the last 30 days, the latest first, with when they were last asked.

Needs the reviews:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

rows

required

Array<object>

object

contact

required

object

id

required

string

name

required

string

email

required

string

phone

required

string

order

required

object

id

required

string

number

required

number

placedAt

required

string format: date-time

subject

required

string

askedAt

required

Any of:

string

string format: date-time

null

null

total

required

number

Example ^generated

{
  "rows": [
    {
      "contact": {
        "id": "example",
        "name": "example",
        "email": "example",
        "phone": "example"
      },
      "order": {
        "id": "example",
        "number": 1,
        "placedAt": "2026-04-15T12:00:00Z",
        "subject": "example"
      },
      "askedAt": "2026-04-15T12:00:00Z"
    }
  ],
  "total": 1
}

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