Sign in
Blacklist

Get Blacklist

Retrieves the blacklist entries.

get/v1/shops/{shopId}/blacklist

Request body

pageinteger

Page number.

perPageinteger

Items per page, 1-100. Must be at least 1. Must not be greater than 100.

orderColumn'id' | 'value' | 'type' | 'match_type' | 'reason' | 'enabled' | 'created_at'
orderDirection'asc' | 'desc'
idstring

Filter by entry ID.

typesstring[]
match_type'exact' | 'regex'
valuestring

Filter by blacklisted value.

reasonstring

Filter by reason.

messagestring

Filter by message.

payment_method_idsobject

Filter by payment method IDs.

enabledboolean

Only enabled or disabled entries.

active_fromstring

Must be a valid date.

active_tostring

Must be a valid date. Must be a date after <code>active_from</code>.

created_at_fromstring

Must be a valid date.

created_at_tostring

Must be a valid date. Must be a date after <code>created_at_from</code>.

Example request

{
  "page": 1
}

Response

current_pageinteger
first_page_urlstring
frominteger
last_pageinteger
last_page_urlstring
next_page_urlstring
pathstring
per_pageinteger
prev_page_urlstring
tointeger
totalinteger

Example response

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "shop_id": 1,
      "type": "email",
      "match_type": "exact",
      "value": "blocked@sellauth.test",
      "payment_method_ids": null,
      "reason": "Example entry",
      "message": null,
      "enabled": true,
      "active_from": null,
      "active_to": null,
      "created_at": "2026-08-28T18:23:02.000000Z",
      "updated_at": "2026-08-28T18:23:02.000000Z",
      "deleted_at": null
    }
  ],
  "first_page_url": "http://api.sellauth.test/v1/shops/1/blacklist?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://api.sellauth.test/v1/shops/1/blacklist?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "http://api.sellauth.test/v1/shops/1/blacklist?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "http://api.sellauth.test/v1/shops/1/blacklist",
  "per_page": 20,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.